- URL: https://<version-url>/startEditing(POST only)
- Version Introduced:10.6
Description
Using the specified sessionId value, an exclusive lock is obtained for the session on the version. The exclusive lock can only be obtained if no other shared or exclusive locks are present and the session currently holds a shared lock. The exclusive lock ensures read and write isolation for the session holding the lock. You can downgrade the exclusive lock to a shared lock using the stopEditing 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) for the version that a new service edit session is being started on. The session ID is often passed as a logical lock token for the version being edited. 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> ]
}
}