BuildQueueApi

deleteAllQueuedBuilds

Delete all queued builds.


Endpoint	/app/rest/buildQueue
Parameters	`locator: string<BuildQueueLocator>` `fields: string`

Get all queued builds.


Endpoint	/app/rest/buildQueue
Produces	`application/xml` `application/json`
Parameters	`locator: string<BuildQueueLocator>` `fields: string`
Response	`Builds`

Add a new build to the queue.


Endpoint	/app/rest/buildQueue
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: Build` `moveToTop: boolean`
Response	`Build`

Update the build queue order.


Endpoint	/app/rest/buildQueue/order
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: Builds` `fields: string`
Response	`Builds`

Get the queue position of a queued matching build.


Endpoint	/app/rest/buildQueue/order/{queuePosition}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`queuePosition: string` `fields: string`
Response	`Build`

Update the queue position of a queued matching build.


Endpoint	/app/rest/buildQueue/order/{queuePosition}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`queuePosition: string` `body: Build` `fields: string`
Response	`Build`

Get approval info of a queued matching build.


Endpoint	/app/rest/buildQueue/{buildLocator}/approvalInfo
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`ApprovalInfo`

Approve queued build with approval feature enabled.


Endpoint	/app/rest/buildQueue/{buildLocator}/approve
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: string` `fields: string`
Response	`ApprovalInfo`

Get tags of the queued matching build.


Endpoint	/app/rest/buildQueue/{buildLocator}/tags
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildQueueLocator>` `locator: string` `fields: string`
Response	`Tags`

Add tags to the matching build.


Endpoint	/app/rest/buildQueue/{buildLocator}/tags
Consumes	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: Tags`

Delete a queued matching build.


Endpoint	/app/rest/buildQueue/{queuedBuildLocator}
Parameters	`queuedBuildLocator: string<BuildQueueLocator>`

Get a queued matching build.


Endpoint	/app/rest/buildQueue/{queuedBuildLocator}
Produces	`application/xml` `application/json`
Parameters	`queuedBuildLocator: string<BuildQueueLocator>` `fields: string`
Response	`Build`

Cancel a queued matching build.


Endpoint	/app/rest/buildQueue/{queuedBuildLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`queuedBuildLocator: string<BuildQueueLocator>` `body: BuildCancelRequest`
Response	`Build`

Get compatible agents for a queued matching build.


Endpoint	/app/rest/buildQueue/{queuedBuildLocator}/compatibleAgents
Produces	`application/xml` `application/json`
Parameters	`queuedBuildLocator: string<BuildQueueLocator>` `fields: string`
Response	`Agents`

Last modified: 13 June 2022