VcsLabel
The VCS-side tag that labels sources of this build.
Related Help article: Labeling Sources
tip
Data type:
string
Example:EAP
The public VCS tag name
tip
Data type:
string
Example:
The reason why the sources could not be labeled. Provides additional information why the status
field returns FAILED.
tip
Data type:
string
Example:SUCCESSFUL_SET
The status of the labeling (tagging) operation. Possible values:
UNKNOWN — the operation status is currently unknown.
SUCCESSFUL_SET — the sources were successfully tagged.
IS_BEING_SET — the labeling (tagging) process is currently ongoing.
FAILED — the sources could not be labeled.
DISABLED_FOR_THE_ROOT — the current root is excluded from the labeling process.
LABELING_NOT_SUPPORTED — VCS does not support labeling.
tip
Data type:
long
Example:9629
The internal ID of the build during which the sources were tagged.
tip
Data type:
VcsRootInstance
Example:
The instance of a VCS root that was used during the tagging process.
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="9629" failureReason="string" status="SUCCESSFUL_SET" text="EAP">
<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...</vcs-root>
<status>vcsStatus...</status>
<repositoryState>repositoryState...</repositoryState>
<properties>properties...</properties>
<repositoryIdStrings>items...</repositoryIdStrings>
</vcs-root-instance>
</vcsLabel>
{
"failureReason" : "failureReason",
"vcs-root-instance" : {
"lastVersion" : "lastVersion",
"vcsRootInternalId" : "vcsRootInternalId",
"commitHookMode" : true,
"vcs-root" : {
"vcsRootInstances" : "vcs-root-instances...",
"project" : "project...",
"projectLocator" : "projectLocator",
"uuid" : "uuid",
"modificationCheckInterval" : 7,
"internalId" : "internalId",
"name" : "name",
"vcsName" : "vcsName",
"id" : "id",
"href" : "href",
"locator" : "locator",
"properties" : "properties...",
"repositoryIdStrings" : "items..."
},
"projectLocator" : "projectLocator",
"modificationCheckInterval" : 8,
"lastVersionInternal" : "lastVersionInternal",
"name" : "name",
"vcsName" : "vcsName",
"vcs-root-id" : "vcs-root-id",
"id" : "id",
"href" : "href",
"properties" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"status" : {
"current" : "VcsCheckStatus...",
"previous" : "VcsCheckStatus..."
},
"repositoryState" : {
"count" : 3,
"branch" : [ "branchVersion..." ],
"timestamp" : "timestamp"
},
"repositoryIdStrings" : {
"item" : [ "item" ]
}
},
"buildId" : 9629,
"text" : "EAP",
"status" : "SUCCESSFUL_SET"
}
Thanks for your feedback!