Start Editing
- URL:https://<versionmanagementservice-url>/startEditing(POST only)
- Version Introduced:10.6
Description
Using the specified session ID and user ID, start a service edit session on the version if the version is not already being edited by another user/session.
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) for the version that a new service edit session is being started on; a required parameter. The session id is often passed as a logical lock token for the version being edited. 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> ]
}
}