- URL:
- https://<root>/<serviceName>/VersionManagementServer/locks
- Methods:
GET- Version Introduced:
- 12.1
Description
The locks resource represents all the locks on versions in a version management service that the current user has access to. It is returned as an array of locks with brief information on the version name, version guid, lock owner, and lock type. Locks on hidden versions are not included.
Use the lockInfos operation to view additional lock properties, including locks for hidden versions.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | Specifies the output format of the response. The default response format is Values: |
JSON Response syntax
{
"locks" : [
{
"versionName" : <string>,
"versionGuid" : <guid>,
"lockOwner" : <string>,
"lockType" : "write” | “read”
}
]
}Example usage
The locks resource for a version management service.
Request URL and JSON response:
https
{
"locks": [
{
"versionName": "JARMAN.version1",
"versionGuid": "{B0410DE4-7583-4AAB-8FE9-D4A2ACF074E6}",
"lockOwner": "ajarman",
"lockType": "write"
},
{
"versionName": "JARMAN.version2",
"versionGuid": "{A0FEE710-029B-46AB-A2D0-A85237540B27}",
"lockOwner": "mjarman",
"lockType": "read"
}
],
"success": true
}