BranchLocator

Represents a locator string for filtering Branch entities. Examples:

build:<buildLocator> - find branch with which the build found by buildLocator was started.
buildType:<buildTypeLocator> - find branches of a build configuration found by buildTypeLocator.

Properties

Dimension	Data type	Format	Description
`$singleValue`	`string`	`String value`	Branch name.
`build`	`string`	`BuildLocator`	Build locator.
`buildType`	`string`	`BuildTypeLocator`	Build type locator.
`changesFromDependencies`	`string`		Include branches from dependencies. Supported values: `true` `false` `any`
`count`	`long`	`int64`	For paginated calls, how many entities to return per page.
`default`	`string`		Is default branch. Supported values: `true` `false` `any`
`name`	`string`	`ValueCondition`	Branch name.
`policy`	`string`		Branch retrieval policy. Supported values: `vcs_branches` `active_vcs_branches` `history_branches` `active_history_branches` `active_history_and_active_vcs_branches` `all_branches`
`start`	`long`	`int64`	For paginated calls, from which entity to start rendering the page.
`unspecified`	`string`		Branch is unspecified if for some reason TeamCity failed to find appropriate branch name for the build. Supported values: `true` `false` `any`

Last modified: 14 March 2025