- URL: https://<versionmanagementservice-url>/versions/<versionGuid>/startReading(POST only)
- Version Introduced:10.6
Description
Using the specified client generated session ID, a shared lock is obtained for the session if the version is not already being edited by another user/session. The shared lock prevents any other session from obtaining an exclusive lock obtained by the startEditing operation. Multiple shared locks may be obtained and held by multiple sessions. The shared lock is released by using the stopReading operation.
Request Parameters
| Parameter | Details |
|---|---|
| f | Description: Optional parameter to specify the output format of the response. The default response format is html. Values: html | json |
| sessionID | Description: The client generated session id (guid) ; a required parameter. Syntax : sessionId = {3F2504E0-4F89-41D3-9A0C-0305E82C3301} |
JSON Response Syntax
{
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}