TeamCity REST API 2020.2 Help

ProjectLocator

Represents a locator string for filtering Project entities. Examples:

  • name:MyProject – find a project with name MyProject.

  • archived:false – find projects which are not archived.

Dimension Data type Format Description

affectedProject

string

ProjectLocator

Project (direct or indirect parent) locator.

archived

boolean

Is archived.

build

string

BuildLocator

Build locator.

buildType

string

BuildTypeLocator

Build type locator.

count

integer

int32

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

defaultTemplate

string

BuildTypeLocator

Default template locator.

id

string

internalId

string

item

string

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

Supply multiple locators and return a union of the results.

name

string

pool

string

AgentPoolLocator

Associated agent pool locator.

project

string

ProjectLocator

Project (direct parent) locator.

projectFeature

string

ProjectLocator

Project feature locator.

start

integer

int32

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

uuid

string

vcsRoot

string

VcsRootLocator

VCS root locator.

Last modified: 22 December 2020