TeamCity 2021.1 Help

Compatibility

Represents a compatibility relation between the agent and build configuration.

Properties

FieldData type

compatible

boolean

agent

Agent

buildType

BuildType

unmetRequirements

Requirements

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<compatibility compatible="true"> <agent authorized="true" connected="true" cpuRank="123" currentAgentVersion="string" disconnectionComment="string" enabled="true" host="string" href="string" id="123" idleSinceTime="string" ip="string" javaOutdated="true" lastActivityTime="string" locator="string" name="string" outdated="true" pluginsOutdated="true" port="123" protocol="string" registrationTimestamp="string" typeId="123" uptodate="true" version="string" webUrl="string"> <build>[[[build...|build.html]]]</build> <links>[[[links...|links.html]]]</links> <enabledInfo>[[[enabledInfo...|enabledinfo.html]]]</enabledInfo> <authorizedInfo>[[[authorizedInfo...|authorizedinfo.html]]]</authorizedInfo> <properties>[[[properties...|properties.html]]]</properties> <cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance> <cloudImage>[[[cloudImage...|cloudimage.html]]]</cloudImage> <environment>[[[environment...|environment.html]]]</environment> <pool>[[[agentPool...|agentpool.html]]]</pool> <compatibilityPolicy>[[[compatibilityPolicy...|compatibilitypolicy.html]]]</compatibilityPolicy> <compatibleBuildTypes>[[[buildTypes...|buildtypes.html]]]</compatibleBuildTypes> <incompatibleBuildTypes>[[[compatibilities...|compatibilities.html]]]</incompatibleBuildTypes> <builds>[[[builds...|builds.html]]]</builds> </agent> <buildType description="string" externalStatusAllowed="true" href="string" id="string" inherited="true" internalId="string" locator="string" name="string" paused="true" projectId="string" projectInternalId="string" projectName="string" templateFlag="true" type="string" uuid="string" webUrl="string"> <links>[[[links...|links.html]]]</links> <project>[[[project...|project.html]]]</project> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <template>[[[buildType...|buildtype.html]]]</template> <vcs-root-entries>[[[vcs-root-entries...|vcsrootentries.html]]]</vcs-root-entries> <settings>[[[properties...|properties.html]]]</settings> <parameters>[[[properties...|properties.html]]]</parameters> <steps>[[[steps...|steps.html]]]</steps> <features>[[[features...|features.html]]]</features> <triggers>[[[triggers...|triggers.html]]]</triggers> <snapshot-dependencies>[[[snapshot-dependencies...|snapshotdependencies.html]]]</snapshot-dependencies> <artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</artifact-dependencies> <agent-requirements>[[[agent-requirements...|agentrequirements.html]]]</agent-requirements> <branches>[[[branches...|branches.html]]]</branches> <builds>[[[builds...|builds.html]]]</builds> <investigations>[[[investigations...|investigations.html]]]</investigations> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> </buildType> <unmetRequirements description="string"/> </compatibility>
{ "compatible" : true, "agent" : { "disconnectionComment" : "disconnectionComment", "idleSinceTime" : "idleSinceTime", "enabledInfo" : "[[[enabledInfo...|enabledinfo.html]]]", "cpuRank" : 0, "enabled" : true, "compatibleBuildTypes" : "[[[buildTypes...|buildtypes.html]]]", "protocol" : "unidirectional", "outdated" : true, "authorized" : true, "host" : "host", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : 9, "href" : "href", "cloudImage" : "[[[cloudImage...|cloudimage.html]]]", "authorizedInfo" : "[[[authorizedInfo...|authorizedinfo.html]]]", "incompatibleBuildTypes" : "[[[compatibilities...|compatibilities.html]]]", "uptodate" : true, "ip" : "ip", "pool" : "[[[agentPool...|agentpool.html]]]", "cloudInstance" : "[[[cloudInstance...|cloudinstance.html]]]", "version" : "version", "connected" : true, "currentAgentVersion" : "currentAgentVersion", "compatibilityPolicy" : "[[[compatibilityPolicy...|compatibilitypolicy.html]]]", "registrationTimestamp" : "registrationTimestamp", "environment" : "[[[environment...|environment.html]]]", "pluginsOutdated" : true, "port" : 5, "build" : "[[[build...|build.html]]]", "webUrl" : "webUrl", "name" : "name", "typeId" : 8, "lastActivityTime" : "lastActivityTime", "locator" : "locator", "properties" : "[[[properties...|properties.html]]]", "javaOutdated" : true }, "buildType" : { "template" : "[[[buildType...|buildtype.html]]]", "paused" : true, "description" : "description", "project" : "[[[project...|project.html]]]", "investigations" : "[[[investigations...|investigations.html]]]", "templateFlag" : true, "type" : "regular", "uuid" : "uuid", "projectInternalId" : "projectInternalId", "internalId" : "internalId", "features" : "[[[features...|features.html]]]", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : "id", "href" : "href", "settings" : "[[[properties...|properties.html]]]", "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "templates" : "[[[buildTypes...|buildtypes.html]]]", "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]", "compatibleAgents" : "[[[agents...|agents.html]]]", "triggers" : "[[[triggers...|triggers.html]]]", "branches" : "[[[branches...|branches.html]]]", "steps" : "[[[steps...|steps.html]]]", "externalStatusAllowed" : true, "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]", "webUrl" : "webUrl", "inherited" : true, "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]", "name" : "name", "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]", "projectName" : "projectName", "projectId" : "projectId", "parameters" : "[[[properties...|properties.html]]]", "locator" : "locator" }, "unmetRequirements" : { "description" : "description" } }
Last modified: 25 May 2021