TeamCity REST API Reference
 
2023.05
You are viewing the documentation for an earlier version of TeamCity REST API Reference.
  1. Autogenerated REST API Reference
  2. Locators
  3. BranchLocator

BranchLocator

Last modified: 22 May 2023

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