- URL:
- https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>/deleteForwardEdits
- Methods:
POST- Required Capability:
- Edit privilege (features:user:edit)
- Version Introduced:
- 10.6
Description
The delete operation deletes all forward edits from the moment provided in an edit session.
Use this operation when a client application manages an edit session made of multiple operations and intends to support an undo/redo stack.
If undo is used during an edit session the delete operation must be called prior to the next apply operation or the stop operation to delete the forward edits. The time stamps for each edit operation must be carefully managed.
Requires the same sessionID and organization member used for the start operation.
Review the read and edit session requirements for version resource operations.
Request parameters
| Parameter | Details |
|---|---|
| Specifies the output format of the response. The default response format is Values: |
| Specifies the client-generated session ID (GUID). Syntax: Example: |
| Specifies a specific Syntax: Example: |
JSON Response syntax
{
"success" : <true | false>,
"error" : { // only if success is false
"extendedCode" : <HRESULT>,
"message" : <error message>,
"details" : [ <detail> ]
}
}Example usage
During an edit session, the delete operation is called before the stop operation to delete edits from the moment specified forward.
Request URL and parameters:
https
f=json
sessionId={638ed440-b81f-406c-bd5d-757c91dbfd70}
moment=1691093291637JSON response:
{
"success": true
}