TeamCity REST API Reference 2024.03 Help

BuildQueueLocator

Represents a locator string for filtering 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.

Properties

Dimension

Data type

Format

Description

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

string

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

Deprecated.

user

string

UserLocator

User locator.

Last modified: 27 March 2024