- URL: https://<versionmanagementservice-url>/versions/<versionGuid>/startReading(POST only)
- Version Introduced:10.6
Description
Using the specified client generated sessionId value, a shared lock is obtained for the session if the version is not currently being edited by another user or 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 using the stopReading operation.
Note:
Review the read and edit session requirements for version resource operations.
Request parameters
| Parameter | Details |
|---|---|
| f | The output response format. The default response format is html. This parameter is optional. Values: html | json |
| sessionId | The client generated session ID (GUID). This parameter is required. 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> ]
}
}