- URL: https://<version-url>/stopEditing
(POST only)
- Version Introduced:10.6
Description
Using the specified session id, the exclusive lock for the version is downgraded to a shared lock.
The saveEdits parameter specifies if the edits for the session should be saved (true) or discarded (false).
- True(save edits)—the session's collection of edits are trimmed into a single moment and the version is updated to reference this moment. The exclusive lock is downgraded to a shared lock.
- False(discard)—the session discards the collection of edits, and all apply edits are removed. The version continues to reference the same moment and the exclusive lock is downgraded to a shared lock.
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} |
| saveEdits | Description: Should the edits in the version be saved; this is a required boolean parameter. Values : true | false |
JSON Response Syntax
{
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}