Reconcile | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>/reconcile
Methods:: POST
Required Capability:: Edit privilege (features:user:edit)
Version Introduced:: 10.6

Description

Use the reconcile operation to reconcile a version with the default version. This operation reviews the differences between the version and the default version and flags them as conflicts depending on the conflictDetection type specified.

To perform a reconcile you must have an exclusive lock on the version. This means, you must have a write lock on the version and no 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. You must have full permissions to all the feature classes and tables that have been modified in the version being reconciled.

The reconcile operation is supported both synchronously and asynchronously.

Review the read and edit session requirements for version resource operations.

Request parameters

Parameter	Details
`f`	Specifies the output format of the response. The default response format is `html`. Values: `html` \| `json` \| `pjson`
`sessionId` (Required)	The client-generated sessionId (GUID). Syntax : `sessionId = {3F2504E0-4F89-41D3-9A0C-0305E82C3301}`
`abortIfConflicts` (Optional)	Specifies whether the reconcile will be aborted if conflicts are detected (`true`). The default boolean value is `false`. Values: `true` \| `false`
`conflictDetection` (Optional)	Specifies whether the conditions required for conflicts to occur will be defined by object (row) or attribute (column). The default is `byObject`. This parameter was introduced at ArcGIS Enterprise 10.8.1. Values: `byObject` \| `byAttribute`
`withPost` (Optional)	Specifies whether a post of the current version will be included following the reconcile (`true` ). The default boolean value is `false`. Values: `true` \| `false`
`async` (Optional)	Specifies whether the request will be processed asynchronously. If `true` , the request will be processed as an asynchronous job, and a URL will be returned that a client can visit to review the status of the job. The default boolean value is `false` . Values: `true` \| `false` This parameter was introduced at ArcGIS Enterprise 10.9.1.

JSON Response syntax

JSON response (when async = false):

Use dark colors for code blocksCopy
{
  "hasConflicts" : <true | false>,
  "moment" : <datetime>,
  "didPost" : <true | false>,
  "success" : <true | false>,
  "error" : { // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

JSON response (when async = true):

Use dark colors for code blocksCopy
{
  "statusUrl" : <url>
}

JSON response to the status URL (when pending or in progress):

Use dark colors for code blocksCopy
{
  "status" : "<Pending | InProgress>",
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>
 }

Example usage

Reconcile a named version with the default version using the reconcile operation. Conflicts are defined by setting the conflictDetection parameter to byAttribute . The optional parameters abortIfConflicts and withPost are both set to true .

Request URL and parameters:

https://myserver.esri.com/server/rest/services/LandUse/VersionManagementServer/versions/24417758-0DBD-4EC3-95B0-467CAA47FC43/reconcile

Use dark colors for code blocksCopy
f=json
sessionId={638ed440-b81f-406c-bd5d-757c91dbfd70}
abortIfConflicts=true
conflictDetection=byAttribute
withPost=true
async=false

JSON response:

Use dark colors for code blocksCopy
{
 "hasConflicts": false,
 "moment": 1582135929926,
 "didPost": true,
 "success": true
}