Skip To Content

Purge Lock

Description

The purgeLock operation deletes all locks for the specified version.

Caution:
If there are active edit sessions for the version, all unsaved edits will be lost. Review the version resource to determine if the version is being edited before using purgeLock.

The following user accounts can run the purgeLock operation:

  • Version owner
  • Service owner
  • Portal administrator

License:
Organization members must be assigned a license for the ArcGIS Advanced Editing user type extension to use this operation.

Request parameters

ParameterDetails
f

Description: The response format. The default response format is html.

Values: html | json

versionName

Description: The qualified name of the version that is locked, for example, owner.version_name. This is a required parameter.

Syntax:versionName=<versionName>

Example: unadmin.test

JSON Response syntax

{
  "success" : <true | false>,
  "error" : { // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }  
}

Example usage

Delete the locks for a specific version using the purgeLock operation:

Request URL and parameters:

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

f=json
versionName=unadmin.test

JSON response:

{
 "success": true
}