Skip to content
URL:
https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>/stopEditing
Methods:
POST
Required Capability:
Edit privilege (features:user:edit)
Version Introduced:
10.6

Description

The 'stopEditing' operation allows you to provide a sessionId value to downgrade a write lock for a version to a read 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 saved and the version is updated to reference that moment.
  • False—The collection of edits from the session are discarded and all applied edits are removed. The version continues to reference the same moment.

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}

saveEdits (Required)

Specifies whether the edits in the version will be saved.

Values: true | false

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.