- URL:
- https://<root>/<serviceName>/VersionManagementServer/versions/<versionGuid>
- Methods:
GET- Operations:
- Alter, Conflicts, Delete Forward Edits, Differences, Inspect Conflicts, Post, Reconcile, Restore Rows, Start Editing, Start Reading, Stop Editing, Stop Reading
- Version Introduced:
- 10.6
Description
The version resource represents a single version under the Version Management service that returns information about the version and supports many operations. The version is accessed using the version value that is obtained from the versions resource.
The following table lists the read and edit session version operation requirements for the version resource:
- Read and edit sessions are established using the
startandReading startoperations. Operations that require an edit session must callEditing startfirst and use the same sessionId for both operations.Reading - The
startoperation obtains an exclusive lock on the version and no other users can connect to the version until the lock is released.Editing
Version operations
| Operation | Read session required | Edit session required |
|---|---|---|
Alter | ||
Conflicts |
| |
Delete Forward Edits |
| |
Differences | ||
Inspect Conflicts |
| |
Post |
| |
Reconcile |
| |
Restore Rows |
|
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: |
JSON Response syntax
{
"versionName": "<owner.versionName>",
"versionGuid": <guid>,
"versionId": <ID>,
"description": "<description>",
"creationDate": <dateTime>,
"modifiedDate": <dateTime>,
"reconcileDate": <dateTime>,
"previousAncestorDate": <dateTime>,
"commonAncestorDate": <dateTime>,
"evaluationDate": <dateTime>,
"isBeingEdited": <true | false>,
"isBeingRead": <true | false>,
"hasConflicts": <true | false>,
"hasUninspectedConflicts": <true | false>,
"isLocked": <true | false>,
"lockOwner": "<lockOwner>",
"lockDate": <dateTime>,
"access": "private" | "public" | "protected",
"success": <true | false>
}Example usage
The version resource is used to return information about a specific version by using the version value. In this example, the version value is F93DB9FD-6F39-45D9-A6C7-D43E69EB3076.
Request URL and JSON response:
https
{
"versionName": "UNADMIN.ProjectA",
"versionGuid": "{F93DB9FD-6F39-45D9-A6C7-D43E69EB3076}",
"versionId": 20,
"description": "",
"creationDate": 1550771990888,
"modifiedDate": 1550853280024,
"reconcileDate": 1550853215169,
"previousAncestorDate": null,
"commonAncestorDate": 1550853215169,
"evaluationDate": null,
"isBeingEdited": false,
"isBeingRead": false,
"hasConflicts": false,
"hasUninspectedConflicts": false,
"isLocked": false,
"lockOwner": "",
"lockDate": -1,
"access": "public",
"success": true
}