Start Reading

URL:
https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>/startReading
Methods:
POST
Version Introduced:
10.6

Description

The 'startReading' operation allows you to use a sessionId 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 startEditing operation. Multiple shared locks may be obtained and held by multiple sessions. The shared lock is released using the stopReading operation.

Review the read and edit session requirements for version resource operations.

Request parameters

ParameterDetails

f

Specifies the output format of the response. The default response format is html.

Values: html | json | pjson

sessionId (Required)

The client generated session ID (GUID).

Syntax: sessionId = {3F2504E0-4F89-41D3-9A0C-0305E82C3301}

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "success" : <true | false>,
  "error" : { // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.