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. BuildTypeLocator

BuildTypeLocator

Last modified: 25 November 2021

Represents a locator string for filtering BuildType entities. Examples:

  • name:MyBuildType — find build configuration with MyBuildType name

  • project:<projectLocator> — find build configurations under project found by projectLocator

Properties

Dimension

Data type

Format

Description

affectedProject

string

ProjectLocator

Project (direct or indirect parent) locator.

build

string

BuildLocator

Build locator.

count

integer

int32

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

id

string

internalId

string

item

string

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

Supply multiple locators and return a union of the results.

name

string

paused

boolean

Is paused.

project

string

ProjectLocator

Project (direct parent) locator.

start

integer

int32

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

template

string

BuildTypeLocator

Base template locator.

templateFlag

boolean

Is a template.

uuid

string

vcsRoot

string

VcsRootLocator

VCS root locator.

vcsRootInstance

string

VcsRootInstanceLocator

VCS root instance locator.