TeamCity REST API Reference 2023.05 Help

VcsRootInstance

Represents a relation between a VCS root and unique settings set for this root.

Related Help article: VCS Settings

Properties

Field

Data type

id

string

vcs-root-id

string

vcsRootInternalId

string

name

string

vcsName

string

modificationCheckInterval

integer

commitHookMode

boolean

lastVersion

string

lastVersionInternal

string

href

string

vcs-root

VcsRoot

status

VcsStatus

repositoryState

RepositoryState

properties

Properties

repositoryIdStrings

Items

projectLocator

string

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.

<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 href="string" id="string" internalId="string" locator="string" modificationCheckInterval="123" name="string" projectLocator="string" uuid="string" vcsName="string"> <project>[[[project...|project.html]]]</project> <properties>[[[properties...|properties.html]]]</properties> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> <repositoryIdStrings>[[[items...|items.html]]]</repositoryIdStrings> </vcs-root> <status> <current>[[[VcsCheckStatus...|vcscheckstatus.html]]]</current> <previous>[[[VcsCheckStatus...|vcscheckstatus.html]]]</previous> </status> <repositoryState count="123" timestamp="string"> <branch>[[[branchVersion...|branchversion.html]]]</branch> </repositoryState> <properties count="123" href="string"> <property>[[[property...|property.html]]]</property> </properties> <repositoryIdStrings item="string"/> </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" ] } }
Last modified: 22 May 2023