Version | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>
Methods:: GET
Operations:: Alter, Conflicts, Delete Forward Edits, Differences, Inspect Conflicts, Partial Post, Post, Reconcile, Restore Rows, Start Editing, Start Reading, Stop Editing, Stop Reading
Version Introduced:: 10.6

Description

The version resource represents a single version under the Version Management service that returns information about the version and supports many operations. The version is accessed using the versionGuid value that is obtained from the versions resource.

Version operations

The following table lists the read and edit session requirements for version operations:

Read and write locks are established using the startReading and startEditing operations and ended using the stopReading and stopEditing operations. Read and edit operations must use the same sessionId value.

Version operation requirements for read and edit sessions are listed for the current ArcGIS Enterprise version. Review the What's new topic for requirement changes at each release.

Operation	Read session required	Edit session required
Alter
Conflicts
Delete Forward Edits
Differences
Inspect Conflicts
Post / Partial Post
Reconcile
Restore Rows

Note

The locking model differs slightly depending on the ArcGIS Enterprise version.

For ArcGIS Enterprise 12.0 and later, the locking model allows for multiple simultaneous viewers and a single editor as follows:

Once an editor begins editing data in a named version, a write lock is obtained. While only one editor is allowed at a time, other users can still acquire a read lock on the version.
To perform a reconcile you must have an exclusive lock on the version. You must have a write lock on the version and no other read locks can exist. After the reconcile, no other users can acquire a read or write lock on the version until the post or stopEditing operation is called.

For ArcGIS Enterprise 11.5 and earlier, the locking model allows for either multiple simultaneous viewers or a single editor as follows:

To start editing a version, an exclusive lock is required. You must have a read lock on the version and no other read locks can exist.
After an edit session is started, no other users can acquire a read lock on the version until the stopEditing operation is called.

Request parameters

Parameter	Details
`f`	Specifies the output format of the response. The default response format is `html`. Values: `html` \| `json` \| `pjson`

JSON Response syntax

Use dark colors for code blocksCopy
{
  "versionName": "<owner.versionName>",
  "versionGuid": <guid>,
  "versionId": <ID>,
  "description": "<description>",
  "creationDate": <dateTime>,
  "modifiedDate": <dateTime>,
  "reconcileDate": <dateTime>,
  "previousAncestorDate": <dateTime>,
  "commonAncestorDate": <dateTime>,
  "evaluationDate": <dateTime>,
  "isBeingEdited": <true | false>,
  "isBeingRead": <true | false>,
  "hasConflicts": <true | false>,
  "hasUninspectedConflicts": <true | false>,
  "isLocked": <true | false>,
  "lockOwner": "<lockOwner>",
  "lockDate": <dateTime>,
  "access": "private" | "public" | "protected",
  "success": <true | false>
}

Example usage

The version resource is used to return information about a specific version by using the versionGUID value. In this example, the versionGuid value is F93DB9FD-6F39-45D9-A6C7-D43E69EB3076.

Request URL and JSON response:

https://myserver.esri.com/server/rest/services/LandUse/VersionManagementServer/versions/F93DB9FD-6F39-45D9-A6C7-D43E69EB3076

Use dark colors for code blocksCopy
{
 "versionName": "UNADMIN.ProjectA",
 "versionGuid": "{F93DB9FD-6F39-45D9-A6C7-D43E69EB3076}",
 "versionId": 20,
 "description": "",
 "creationDate": 1550771990888,
 "modifiedDate": 1550853280024,
 "reconcileDate": 1550853215169,
 "previousAncestorDate": null,
 "commonAncestorDate": 1550853215169,
 "evaluationDate": null,
 "isBeingEdited": false,
 "isBeingRead": false,
 "hasConflicts": false,
 "hasUninspectedConflicts": false,
 "isLocked": false,
 "lockOwner": "",
 "lockDate": -1,
 "access": "public",
 "success": true
}