Revision

The VCS revision for a related change.

Properties

version

The SHA revision.

internalVersion

The internally used revision number.

vcsBranchName

The full name of a VCS branch where a corresponding change was authored.

vcs-root-instance

The VCS root instance that delivered the change related to this revision.

checkout-rules

The checkout rules of a configuration whose build processed a related change.

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.

<Revision checkout-rules="+:. => maven-root-repo" internalVersion="version" vcsBranchName="refs/heads/main" version="version">
  <vcs-root-instance commitHookMode="false" href="/app/rest/vcs-root-instances/id:264" id="261" lastVersion="6feff116ab9ad0d3af686526a6ff96272620e70f" lastVersionInternal="6feff116ab9ad0d3af686526a6ff96272620e70f" modificationCheckInterval="60" name="customRootFromConfig" projectLocator="string" vcs-root-id="MyProject_CustomRootFromConfig" vcsName="jetbrains.git" vcsRootInternalId="599">
    <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>
</Revision>

{
  "vcsBranchName" : "refs/heads/main",
  "vcs-root-instance" : {
    "lastVersion" : "6feff116ab9ad0d3af686526a6ff96272620e70f",
    "vcsRootInternalId" : "599",
    "commitHookMode" : false,
    "vcs-root" : {
      "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
      "project" : "[[[project...|project.html]]]",
      "projectLocator" : "Obsolete",
      "uuid" : "02308f8f-60f8-4b28-a964-7911ef0159eb",
      "modificationCheckInterval" : 2,
      "internalId" : "599",
      "name" : "MainGitRoot",
      "vcsName" : "jetbrains.git",
      "connectionId" : "my-github-connection-id",
      "id" : "Builders_MainGitRoot",
      "href" : "/app/rest/vcs-roots/id:Builders_MainGitRoot",
      "locator" : "id:Builders_MainGitRoot",
      "properties" : "[[[properties...|properties.html]]]",
      "repositoryIdStrings" : "[[[items...|items.html]]]"
    },
    "projectLocator" : "projectLocator",
    "modificationCheckInterval" : 60,
    "lastVersionInternal" : "6feff116ab9ad0d3af686526a6ff96272620e70f",
    "name" : "customRootFromConfig",
    "vcsName" : "jetbrains.git",
    "vcs-root-id" : "MyProject_CustomRootFromConfig",
    "id" : "261",
    "href" : "/app/rest/vcs-root-instances/id:264",
    "properties" : {
      "count" : 1,
      "property" : [ {
        "inherited" : true,
        "name" : "name",
        "type" : "[[[type...|type.html]]]",
        "value" : "value"
      } ],
      "href" : "href"
    },
    "status" : {
      "current" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]",
      "previous" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]"
    },
    "repositoryState" : {
      "count" : 9,
      "branch" : [ "[[[branchVersion...|branchversion.html]]]" ],
      "timestamp" : "20250412T151928+0200"
    },
    "repositoryIdStrings" : {
      "item" : [ "item" ]
    }
  },
  "checkout-rules" : "+:. => maven-root-repo",
  "internalVersion" : "version",
  "version" : "version"
}

Last modified: 02 December 2025