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

VcsRootInstanceLocator

Last modified: 22 May 2023

Represents a locator string for filtering VcsRootInstance entities. Examples:

  • vcsRoot:<vcsRootLocator> — find all VCS root instances of a VCS root found by vcsRootLocator.

  • project:<projectLocator> — find all VCS root instances defined 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.

buildType

string

BuildTypeLocator

Build type locator.

count

integer

int32

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

id

string

Entity ID.

item

string

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

Supply multiple locators and return a union of the results.

lookupLimit

integer

int32

Limit processing to the latest <lookupLimit> entities.

project

string

ProjectLocator

Project (direct parent) locator.

property

string

property:(name:<name>,value:<value>,matchType:<matchType>)

Supported values:

  • exists

  • not-exists

  • equals

  • does-not-equal

  • starts-with

  • contains

  • does-not-contain

  • ends-with

  • any

  • matches

  • does-not-match

  • more-than

  • no-more-than

  • less-than

  • no-less-than

  • ver-more-than

  • ver-no-more-than

  • ver-less-than

  • ver-no-less-than

start

integer

int32

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

type

string

Type of VCS (e.g. jetbrains.git).

vcsRoot

string

VcsRootLocator

VCS root locator.

versionedSettings

boolean

Is used for versioned settings.