Skip To Content

Stop Editing

  • URL: https://<version-url>/stopEditing (POST only)
  • Version Introduced:10.6

Description

Using the specified sessionId value, the exclusive lock for the version is downgraded to a shared lock.

The saveEdits parameter specifies whether the edits for the session will be saved (true) or discarded (false).

  • True—The collection of edits from the session are trimmed into a single moment and the version is updated to reference that moment. The exclusive lock is downgraded to a shared lock.
  • False—The collection of edits from the session are discarded and all applied edits are removed. The version continues to reference the same moment, and the exclusive lock is downgraded to a shared lock.

Note:

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

Request parameters

ParameterDetails
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}

saveEdits

Specifies whether the edits in the version will be saved. This parameter is a Boolean value and is required.

Values : true | false

JSON Response syntax

{
  "success" : <true | false>,
  "error" : { // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}