AgentPool

Represents an agent pool instance.

Properties

Field	Data type
`id`	`integer`
`name`	`string`
`href`	`string`
`maxAgents`	`integer`
`ownerProject`	`Project`
`projects`	`Projects`
`agents`	`Agents`
`locator`	`string`

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.

<agentPool href="string" id="123" locator="string" maxAgents="123" name="string">
  <ownerProject archived="true" description="string" href="string" id="string" internalId="string" locator="string" name="string" parentProjectId="string" parentProjectInternalId="string" parentProjectName="string" uuid="string" virtual="true" webUrl="string">
    <links>[[[links...|links.html]]]</links>
    <parentProject>[[[project...|project.html]]]</parentProject>
    <readOnlyUI>[[[StateField...|statefield.html]]]</readOnlyUI>
    <defaultTemplate>[[[buildType...|buildtype.html]]]</defaultTemplate>
    <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes>
    <templates>[[[buildTypes...|buildtypes.html]]]</templates>
    <parameters>[[[properties...|properties.html]]]</parameters>
    <vcsRoots>[[[vcs-roots...|vcsroots.html]]]</vcsRoots>
    <projectFeatures>[[[projectFeatures...|projectfeatures.html]]]</projectFeatures>
    <projects>[[[projects...|projects.html]]]</projects>
    <cloudProfiles>[[[cloudProfiles...|cloudprofiles.html]]]</cloudProfiles>
    <ancestorProjects>[[[projects...|projects.html]]]</ancestorProjects>
  </ownerProject>
  <projects count="123" href="string" nextHref="string" prevHref="string">
    <project>[[[project...|project.html]]]</project>
  </projects>
  <agents count="123" href="string" nextHref="string" prevHref="string">
    <agent>[[[agent...|agent.html]]]</agent>
  </agents>
</agentPool>

{
  "projects" : {
    "count" : 6,
    "project" : [ "[[[project...|project.html]]]" ],
    "prevHref" : "prevHref",
    "href" : "href",
    "nextHref" : "nextHref"
  },
  "maxAgents" : 4,
  "ownerProject" : {
    "virtual" : true,
    "parentProjectName" : "parentProjectName",
    "vcsRoots" : {
      "count" : 4,
      "vcs-root" : [ "[[[vcs-root...|vcsroot.html]]]" ],
      "prevHref" : "prevHref",
      "href" : "href",
      "nextHref" : "nextHref"
    },
    "projects" : {
      "count" : 6,
      "project" : [ "[[[project...|project.html]]]" ],
      "prevHref" : "prevHref",
      "href" : "href",
      "nextHref" : "nextHref"
    },
    "defaultTemplate" : {
      "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",
      "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
      "settings" : "[[[properties...|properties.html]]]",
      "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
      "compatibleAgents" : "[[[agents...|agents.html]]]",
      "pauseComment" : "[[[comment...|comment.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"
    },
    "description" : "description",
    "uuid" : "uuid",
    "parentProjectInternalId" : "parentProjectInternalId",
    "cloudProfiles" : {
      "count" : 4,
      "prevHref" : "prevHref",
      "href" : "href",
      "cloudProfile" : [ "[[[cloudProfile...|cloudprofile.html]]]" ],
      "nextHref" : "nextHref"
    },
    "internalId" : "internalId",
    "archived" : true,
    "parentProjectId" : "parentProjectId",
    "links" : {
      "count" : 5,
      "link" : [ "[[[link...|link.html]]]" ]
    },
    "id" : "id",
    "href" : "href",
    "parentProject" : {
      "virtual" : true,
      "parentProjectName" : "parentProjectName",
      "vcsRoots" : "[[[vcs-roots...|vcsroots.html]]]",
      "projects" : "[[[projects...|projects.html]]]",
      "defaultTemplate" : "[[[buildType...|buildtype.html]]]",
      "description" : "description",
      "uuid" : "uuid",
      "parentProjectInternalId" : "parentProjectInternalId",
      "cloudProfiles" : "[[[cloudProfiles...|cloudprofiles.html]]]",
      "internalId" : "internalId",
      "archived" : true,
      "parentProjectId" : "parentProjectId",
      "links" : "[[[links...|links.html]]]",
      "id" : "id",
      "href" : "href",
      "parentProject" : "[[[project...|project.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "readOnlyUI" : "[[[StateField...|statefield.html]]]",
      "webUrl" : "webUrl",
      "buildTypes" : "[[[buildTypes...|buildtypes.html]]]",
      "name" : "name",
      "ancestorProjects" : "[[[projects...|projects.html]]]",
      "parameters" : "[[[properties...|properties.html]]]",
      "projectFeatures" : "[[[projectFeatures...|projectfeatures.html]]]",
      "locator" : "locator"
    },
    "templates" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 3,
      "prevHref" : "prevHref",
      "href" : "href",
      "nextHref" : "nextHref"
    },
    "readOnlyUI" : {
      "inherited" : true,
      "value" : true
    },
    "webUrl" : "webUrl",
    "buildTypes" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 3,
      "prevHref" : "prevHref",
      "href" : "href",
      "nextHref" : "nextHref"
    },
    "name" : "name",
    "ancestorProjects" : {
      "count" : 6,
      "project" : [ "[[[project...|project.html]]]" ],
      "prevHref" : "prevHref",
      "href" : "href",
      "nextHref" : "nextHref"
    },
    "parameters" : {
      "property" : [ {
        "inherited" : true,
        "name" : "name",
        "type" : "[[[type...|type.html]]]",
        "value" : "value"
      } ],
      "count" : 2,
      "href" : "href"
    },
    "projectFeatures" : {
      "projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ],
      "count" : 0,
      "href" : "href"
    },
    "locator" : "locator"
  },
  "name" : "name",
  "id" : 8,
  "href" : "href",
  "locator" : "locator",
  "agents" : {
    "agent" : [ "[[[agent...|agent.html]]]" ],
    "count" : 0,
    "prevHref" : "prevHref",
    "href" : "href",
    "nextHref" : "nextHref"
  }
}

Last modified: 22 May 2023