TeamCity REST API 2020.2 Help

BuildQueueLocator

Represents a locator string for filtering queued Build entities. Examples:

  • buildType:<buildTypeLocator> – find queued builds under build configuration found by buildTypeLocator.

  • user:<userLocator> – find queued builds started by user found by userLocator.

Dimension Data type Format Description

$singleValue

boolean

Return a single value.

agent

string

AgentLocator

Agent locator.

buildType

string

BuildTypeLocator

Build type locator.

count

integer

int32

For paginated calls, how many entities to return per page.

id

integer

int32

Entity ID.

item

string

item:(<locator1>),item:(<locator2>...)

Supply multiple locators and return a union of the results.

personal

boolean

Is personal.

pool

string

AgentPoolLocator

Agent pool locator.

project

string

ProjectLocator

Project locator.

start

integer

int32

For paginated calls, from which entity to start rendering the page.

taskId

string

user

string

UserLocator

User locator.

Last modified: 22 December 2020