- URL:
- https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>/startReading
- Methods:
POST- Version Introduced:
- 10.6
Description
The 'startReading' operation allows you to use a session value to generate a shared lock on a branch version (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 start operation. Multiple shared locks may be obtained and held by multiple sessions. The shared lock is released using the stop operation.
Review the read and edit session requirements for version resource operations.
Request parameters
| Parameter | Details |
|---|---|
| Specifies the output format of the response. The default response format is Values: |
| The client generated session ID (GUID). Syntax: |
JSON Response syntax
{
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}