TeamCity 2021.1 Help

BuildLocator

Represents a locator string for filtering Build entities. Examples:

  • id:1 — find build with ID 1.

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

  • defaultFilter:false,agent:<agentLocator> — find builds executed on agent found by agentLocator, with defaultFilter disabled (see below).

Properties

DimensionData typeFormatDescription

affectedProject

string

ProjectLocator

Project (direct or indirect parent) locator.

agent

string

AgentLocator

Agent locator.

agentTypeId

integer

int32

typeId of agent used to execute build.

any

boolean

State can be any.

artifactDependency

string

branch

string

BranchLocator

Branch locator.

buildType

string

BuildTypeLocator

Build type locator.

canceled

boolean

Is canceled.

compatibleAgent

string

AgentLocator

Agent locator.

composite

boolean

Is composite.

count

integer

int32

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

defaultFilter

boolean

If true, applies default filter which returns only "normal" builds (finished builds which are not canceled, not failed-to-start, not personal, and on default branch (in branched build configurations)).

failedToStart

boolean

Is failed to start.

finishDate

string

date:<yyyyMMddTHHmmss+ZZZZ>,build:<build locator>,condition:<before/after>

Requires either date or build dimension.

finished

boolean

Is finished.

hanging

boolean

Is hanging.

history

boolean

Is history build.

id

integer

int32

Entity ID.

item

string

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

Supply multiple locators and return a union of the results.

lookupLimit

integer

int32

Limit processing to the latest <lookupLimit> entities.

number

string

personal

boolean

Is a personal build.

pinned

boolean

Is pinned.

project

string

ProjectLocator

Project (direct parent) locator.

property

string

property:(name:<name>,value:<value>,matchType:<matchType>)

Supported values: * `exists` * `not-exists` * `equals` * `does-not-equal` * `starts-with` * `contains` * `does-not-contain` * `ends-with` * `any` * `matches` * `does-not-match` * `more-than` * `no-more-than` * `less-than` * `no-less-than` * `ver-more-than` * `ver-no-more-than` * `ver-less-than` * `ver-no-less-than`

queued

boolean

Is queued.

queuedDate

string

date:<yyyyMMddTHHmmss+ZZZZ>,build:<build locator>,condition:<before/after>

Requires either date or build dimension.

running

boolean

Is running.

snapshotDependency

string

start

integer

int32

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

startDate

string

date:<yyyyMMddTHHmmss+ZZZZ>,build:<build locator>,condition:<before/after>

Requires either date or build dimension.

state

string

Supported values: * `queued` * `running` * `finished` * `any`

status

string

tag

string

TagLocator

Tag locator.

taskId

integer

int32

ID of a build or build promotion.

user

string

UserLocator

User locator.

Last modified: 25 May 2021