Compatibility

An entity that describes the compatibility relation between an agent and a build configuration.

Properties

compatible

Returns true if the target agent is compatible with the given configuration (that is, can run its builds); otherwise, false.

agent

The agent whose compatibility data with the buildType is stored in this object.

buildType

The build configuration whose compatibility data with the agent is stored in this object.

unmetRequirements

Returns the list of compatibility issues that makes this agent incompatible with the buildType. This list is empty if the compatible property is true.

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="396" currentAgentVersion="160569" disconnectionComment="Unregistered because of inactivity" enabled="true" host="ip-52-211-39-10.eu-west-1.compute.internal, localhost" href="/app/rest/agents/id:771" id="771" idleSinceTime="20240816T150655+0200" ip="52.211.39.100" javaOutdated="false" lastActivityTime="20240816T151123+0200" locator="string" name="Ubuntu-22.04-Large-i-045902939eae4af1a" outdated="true" pluginsOutdated="false" port="9090" protocol="string" registrationTimestamp="20240816T150655+0200" typeId="661" uptodate="false" version="156364" webUrl="https://example.com/agentDetails.html?id=771&amp;agentTypeId=11389&amp;realAgentName=db-win-2003">
    <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>
    <compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages>
    <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances>
    <pauseComment>[[[comment...|comment.html]]]</pauseComment>
  </buildType>
  <unmetRequirements description="string"/>
</compatibility>

{
  "compatible" : true,
  "agent" : "[[[agent...|agent.html]]]",
  "buildType" : "[[[buildType...|buildtype.html]]]",
  "unmetRequirements" : "[[[requirements...|requirements.html]]]"
}

Last modified: 21 August 2024