TeamCity REST API Reference 2023.05 Help

VcsLabel

Represents a VCS-side label of this build's sources.

Related Help article: Labeling Sources

Properties

Field

Data type

Allowed values

text

string

failureReason

string

status

string

  • UNKNOWN

  • SUCCESSFUL_SET

  • IS_BEING_SET

  • FAILED

  • DISABLED_FOR_THE_ROOT

  • LABELING_NOT_SUPPORTED

buildId

long

vcs-root-instance

VcsRootInstance

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<vcsLabel buildId="123456789" failureReason="string" status="string" text="string"> <vcs-root-instance commitHookMode="true" href="string" id="string" lastVersion="string" lastVersionInternal="string" modificationCheckInterval="123" name="string" projectLocator="string" vcs-root-id="string" vcsName="string" vcsRootInternalId="string"> <vcs-root>[[[vcs-root...|vcsroot.html]]]</vcs-root> <status>[[[vcsStatus...|vcsstatus.html]]]</status> <repositoryState>[[[repositoryState...|repositorystate.html]]]</repositoryState> <properties>[[[properties...|properties.html]]]</properties> <repositoryIdStrings>[[[items...|items.html]]]</repositoryIdStrings> </vcs-root-instance> </vcsLabel>
{ "failureReason" : "failureReason", "vcs-root-instance" : { "lastVersion" : "lastVersion", "vcsRootInternalId" : "vcsRootInternalId", "commitHookMode" : true, "vcs-root" : { "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "project" : "[[[project...|project.html]]]", "projectLocator" : "projectLocator", "uuid" : "uuid", "modificationCheckInterval" : 4, "internalId" : "internalId", "name" : "name", "vcsName" : "vcsName", "id" : "id", "href" : "href", "locator" : "locator", "properties" : "[[[properties...|properties.html]]]", "repositoryIdStrings" : "[[[items...|items.html]]]" }, "projectLocator" : "projectLocator", "modificationCheckInterval" : 8, "lastVersionInternal" : "lastVersionInternal", "name" : "name", "vcsName" : "vcsName", "vcs-root-id" : "vcs-root-id", "id" : "id", "href" : "href", "properties" : { "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "count" : 2, "href" : "href" }, "status" : { "current" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]", "previous" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]" }, "repositoryState" : { "count" : 3, "branch" : [ "[[[branchVersion...|branchversion.html]]]" ], "timestamp" : "timestamp" }, "repositoryIdStrings" : { "item" : [ "item" ] } }, "buildId" : 9, "text" : "text", "status" : "UNKNOWN" }
Last modified: 22 May 2023