TeamCity REST API Reference 2024.03 Help

VcsRoot

Represents a VCS root.

Related Help article: VCS Root

Properties

Field

Data type

id

string

internalId

string

uuid

string

name

string

vcsName

string

modificationCheckInterval

integer

href

string

project

Project

properties

Properties

vcsRootInstances

VcsRootInstances

repositoryIdStrings

Items

locator

string

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 href="string" id="string" internalId="string" locator="string" modificationCheckInterval="123" name="string" projectLocator="string" uuid="string" vcsName="string"> <project archived="true" description="string" href="string" id="string" internalId="string" locator="string" name="string" parentProjectId="string" parentProjectInternalId="string" parentProjectName="string" uuid="string" virtual="true" webUrl="string"> <links>[[[links...|links.html]]]</links> <parentProject>[[[project...|project.html]]]</parentProject> <readOnlyUI>[[[StateField...|statefield.html]]]</readOnlyUI> <defaultTemplate>[[[buildType...|buildtype.html]]]</defaultTemplate> <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <parameters>[[[properties...|properties.html]]]</parameters> <vcsRoots>[[[vcs-roots...|vcsroots.html]]]</vcsRoots> <projectFeatures>[[[projectFeatures...|projectfeatures.html]]]</projectFeatures> <projects>[[[projects...|projects.html]]]</projects> <cloudProfiles>[[[cloudProfiles...|cloudprofiles.html]]]</cloudProfiles> <ancestorProjects>[[[projects...|projects.html]]]</ancestorProjects> </project> <properties count="123" href="string"> <property>[[[property...|property.html]]]</property> </properties> <vcsRootInstances count="123" href="string" nextHref="string" prevHref="string"> <vcs-root-instance>[[[vcs-root-instance...|vcsrootinstance.html]]]</vcs-root-instance> </vcsRootInstances> <repositoryIdStrings item="string"/> </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]]]" }
Last modified: 27 March 2024