Version Management Service

Description

The VersionManagementServer service exposes the management capabilities necessary to support feature services that work with branch versioned datasets. This service is available when sharing to ArcGIS Enterprise by enabling the Version management capability. To learn more, see Additional layers and capabilities.

The following are supported operations for the VersionManagementServer service:

• create
• delete
• purgeLock
• versionInfos

The version resource returns information about a single version and supports many operations for that version.

The version management server shares service instance settings and is tied to the published feature service as a server object extension (SOE).

Learn how to configure service instance settings

Usage requirements

When using the VersionManagementServer resources and operations, keep the following in mind:

• The portal account is used to access resources and operations of the version management server. This account determines whether the operation is allowed by the portal user as well as the results that are returned. For example, the versions resource only lists versions the current portal account has access to.

• A read or edit session must be started before running certain operations. Read and edit sessions are started by calling the startReading and startEditing operations, respectively.

• Locks must be obtained on a version when running certain operations. Each operation will try to place the necessary lock on the version before processing and will fail if it cannot acquire the appropriate lock. The following lock modes are available in a geodatabase:

  • Shared lock—Operations that allow more than one user to access a version require a shared lock.
  • Exclusive lock—Operations that must be performed in isolation require an exclusive lock on the version.

Capabilities

The capabilities property was introduced at ArcGIS Enterprise 10.8.1. This property returns the capabilities the service supports. Refer to the JSON Response syntax section below for the ArcGIS Enterprise version when each capability was first introduced:

• supportsConflictDetectionByAttribute—The reconcile operation supports the conflictDetection parameter to allow conflicts to be defined by attribute. Services that don't support this capability define all conflicts by object.
• supportsPartialPost—The post operation supports using the rows parameter to support posting a portion of the edits (differences) in the version to default.
• supportsDifferencesWithMoment—The differences operation supports using the fromMoment parameter to allow a user to obtain differences between two moments.
• supportsDifferencesWithLayers—The differences operation supports using the layers parameter to allow users to filter the differences returned by layer instead of getting differences for all layers.
• supportsAsyncReconcile —The reconcileoperation supports asynchronous processing using theasync` parameter.
• supportsAsyncPost—The post operation supports asynchronous processing using the async parameter.
• supportsAsyncDifferences—The differences operation supports asynchronous processing using the async parameter.
• supportsOutSR—The differences and conflicts operations support the outSR parameter.

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "name": "Version Management Server",
  "type": "Map Server Extension",
  "defaultVersionName": "<versionName>"
  "defaultVersionGuid": <guid>,
  "capabilities": {
   "supportsConflictDetectionByAttribute": <true | false>, //Introduced at  10.8.1
   “supportsPartialPost” : <true | false>, //Introduced at  10.9
   "supportsDifferencesFromMoment" : <true | false>, //Introduced at  10.9
   "supportsDifferencesWithLayers" : <true | false>, //Introduced at  10.9.1
   "supportsAsyncReconcile" : <true | false>, //Introduced at  10.9.1
   "supportsAsyncPost" : <true | false>, //Introduced at  10.9.1
   "supportsAsyncDifferences" : <true | false>, //Introduced at  10.9.1
   "supportsOutSR" : <true | false>, //Introduced at  11.1
  }
}

Example usage

The following is a request URL example:

https://myserver.esri.com/server/rest/services/LandUse/VersionManagementServer

JSON response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
 "name": "Version Management Server",
 "type": "Map Server Extension",
 "defaultVersionName": "SDE.DEFAULT",
 "defaultVersionGuid": "{BD3F4817-9A00-41AC-B0CC-58F78DBAE0A1}",
 "capabilities": {
  "supportsConflictDetectionByAttribute": true,
  “supportsPartialPost”: true,
  "supportsDifferencesFromMoment": true,
  "supportsDifferencesWithLayers": true,
  "supportsAsyncReconcile": true,
  "supportsAsyncPost": true,
  "supportsAsyncDifferences": true,
  "supportsOutSR": true
  }
}