AgentPoolApi

getAllAgentPools

Get all agent pools.


Endpoint	/app/rest/agentPools
Produces	`application/xml` `application/json`
Parameters	`locator: string<AgentPoolLocator>` `fields: string`
Response	`AgentPools`

Create a new agent pool.


Endpoint	/app/rest/agentPools
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: AgentPool`
Response	`AgentPool`

Delete the agent pool matching the locator.


Endpoint	/app/rest/agentPools/{agentPoolLocator}
Parameters	`agentPoolLocator: string<AgentPoolLocator>`

Get the agent pool matching the locator.


Endpoint	/app/rest/agentPools/{agentPoolLocator}
Produces	`application/xml` `application/json`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `fields: string`
Response	`AgentPool`

Get the agent of the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/agents
Produces	`application/xml` `application/json`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `locator: string<AgentLocator>` `fields: string`
Response	`Agents`

Assign the agent to the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/agents
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `body: Agent` `fields: string`
Response	`Agent`

Unassign all projects from the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/projects
Parameters	`agentPoolLocator: string<AgentPoolLocator>`

Get all projects of the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/projects
Produces	`application/xml` `application/json`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `fields: string`
Response	`Projects`

Assign the project to the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/projects
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `body: Project`
Response	`Project`

Update projects of the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/projects
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `body: Projects`
Response	`Projects`

Unassign the project from the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/projects/{projectLocator}
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `projectLocator: string<ProjectLocator>`

Get a field of the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/{field}
Produces	`text/plain`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `field: string`
Response	`string`

Update a field of the matching agent pool.


Endpoint	/app/rest/agentPools/{agentPoolLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`agentPoolLocator: string<AgentPoolLocator>` `field: string` `body: string`
Response	`string`

Last modified: 30 March 2022