Lock Infos | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/VersionManagementServer/lockInfos
Methods:: POST
Version Introduced:: 12.1

Description

The lockInfos operation returns the information for version locks that the current user has access. There are several optional parameters for filtering the locks.

Request parameters

Parameter	Details
`f` (Optional)	Specifies the output format of the response. The default response format is `html`. Values: `html` \| `json` \| `pjson`
`versionNameFilter` (Optional)	Filter the locks by the version name. Syntax: `versionNameFilter = <string>`
`versionOwnerFilter` (Optional)	Filter the locks by the version owner. Syntax: `versionOwnerFilter = <string>`
`lockOwnerFilter` (Optional)	Filter the locks by the lock owner. Syntax: `lockOwnerFilter = <string>`
`lockTypeFilter` (Optional)	Filter the locks by lock type. Values: `read` \| `write`
`includeHiddenVersions` (Optional)	Specifies whether to return locks of versions with hidden access. The default is `false`. Values: `true` \| `false`
`includeExpiredLocks` (Optional)	Specifies whether to return locks that are expired based on the `lockDate` and `lockDuration`. The default is `false`. Values: `true` \| `false`

JSON Response syntax

Use dark colors for code blocksCopy
{
 "locks" : [
  {
   "versionName" : "<versionName>",
   "versionGuid" :  <guid>,
   "lockOwner" : "<lockOwner>",
   "sessionId" : <guid>,
   "lockDate" : <dateTime>,
   "lockDuration" : <long>,
   "lockType" : "write" | "read",
   "canPost" : True | False
  }
 ],
 "success" : <true | false>,
 "error" : { // only if success is false
  "extendedCode" : <HRESULT>,
  "message" : "<error message>",
  "details" : [ <detail>
  ]
 }
}

Example usage

Return information for locks on versions owned by the JARMAN user using the lockInfos operation. Include versions with all access types by using includeHidden=true.

Request URL and JSON response:

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

Use dark colors for code blocksCopy
f=json
ownerFilter=JARMAN
includeHidden=true

Use dark colors for code blocksCopy
{
 "locks": [
  {
   "versionName": "JARMAN.version1",
   "versionGuid": "{B0410DE4-7583-4AAB-8FE9-D4A2ACF074E6}",
   "lockOwner": "ajarman",
   "sessionId": "{4892896D-1936-479D-8AC6-858E8D20D8E0}",
   "lockDate": 1767993135000,
   "lockDuration": 4,
   "lockType": "write",
   "canPost": false
  },
  {
   "versionName": "JARMAN.version2",
   "versionGuid": "{A0FEE710-029B-46AB-A2D0-A85237540B27}",
   "lockOwner": "mjarman",
   "sessionId": "{CFAA6509-A3AC-4C46-8FDD-B1E4C593174B}",
   "lockDate": 1767993133000,
   "lockDuration": 4,
   "lockType": "read",
   "canPost": false
  }
 ],
 "success": true
}