TeamCity REST API Reference 2023.05 Help

Change

Represents a VCS change (commit).

Related Help article: Change

Properties

Field

Data type

id

long

version

string

internalVersion

string

username

string

date

string

registrationDate

string

personal

boolean

href

string

webUrl

string

comment

string

user

User

type

string

snapshotDependencyLink

SnapshotDependencyLink

files

FileChanges

vcsRootInstance

VcsRootInstance

parentChanges

Changes

parentRevisions

Items

attributes

Properties

storesProjectSettings

boolean

status

ChangeStatus

commiter

Commiter

canEditComment

boolean

locator

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.

<change canEditComment="true" comment="string" date="string" href="string" id="123456789" internalVersion="string" locator="string" personal="true" registrationDate="string" storesProjectSettings="true" type="string" username="string" version="string" webUrl="string"> <user email="string" enabled2FA="true" hasPassword="true" href="string" id="123456789" lastLogin="string" locator="string" name="string" password="string" realm="string" username="string"> <properties>[[[properties...|properties.html]]]</properties> <roles>[[[roles...|roles.html]]]</roles> <groups>[[[groups...|groups.html]]]</groups> <avatars>[[[userAvatars...|useravatars.html]]]</avatars> </user> <snapshotDependencyLink buildTypeBranch="string"> <build>[[[build...|build.html]]]</build> <buildType>[[[buildType...|buildtype.html]]]</buildType> </snapshotDependencyLink> <files count="123"> <file>[[[FileChange...|filechange.html]]]</file> </files> <vcsRootInstance 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> </vcsRootInstance> <parentChanges count="123" href="string" nextHref="string" prevHref="string"> <change>[[[change...|]]]</change> </parentChanges> <parentRevisions item="string"/> <attributes count="123" href="string"> <property>[[[property...|property.html]]]</property> </attributes> <status cancelledBuilds="123" failedBuilds="123" finishedBuilds="123" newFailedTests="123" otherFailedTests="123" pendingBuildTypes="123" queuedBuildsCount="123" runningBuilds="123" runningSuccessfullyBuilds="123" successfulBuilds="123" totalProblems="123"> <criticalBuilds>[[[builds...|builds.html]]]</criticalBuilds> <notCriticalBuilds>[[[builds...|builds.html]]]</notCriticalBuilds> <newTestsFailedBuilds>[[[builds...|builds.html]]]</newTestsFailedBuilds> <compilationErrorBuilds>[[[builds...|builds.html]]]</compilationErrorBuilds> </status> <commiter vcsUsername="string"> <users>[[[users...|users.html]]]</users> </commiter> </change>
{ "date" : "date", "vcsRootInstance" : "[[[vcs-root-instance...|vcsrootinstance.html]]]", "canEditComment" : true, "personal" : true, "storesProjectSettings" : true, "type" : "type", "version" : "version", "snapshotDependencyLink" : "[[[SnapshotDependencyLink...|snapshotdependencylink.html]]]", "webUrl" : "webUrl", "registrationDate" : "registrationDate", "files" : "[[[fileChanges...|filechanges.html]]]", "parentRevisions" : "[[[items...|items.html]]]", "internalVersion" : "internalVersion", "comment" : "comment", "attributes" : "[[[properties...|properties.html]]]", "id" : 7, "href" : "href", "user" : "[[[user...|user.html]]]", "commiter" : "[[[commiter...|commiter.html]]]", "locator" : "locator", "parentChanges" : "[[[changes...|changes.html]]]", "username" : "username", "status" : "[[[ChangeStatus...|changestatus.html]]]" }
Last modified: 22 May 2023