TeamCity REST API Reference 2022.10 Help

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

branched

string

boolean

Is feature branch.

build

string

BuildLocator

Build locator.

buildType

string

BuildTypeLocator

Build type locator.

default

string

boolean

Is default branch.

item

string

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

Supply multiple locators and return a union of the results.

name

string

policy

string

Supported values:

  • VCS_BRANCHES

  • ACTIVE_VCS_BRANCHES

  • HISTORY_BRANCHES

  • ACTIVE_HISTORY_BRANCHES

  • ACTIVE_HISTORY_AND_ACTIVE_VCS_BRANCHES

  • ALL_BRANCHES

Last modified: 30 November 2022