Versioning

Versioned Objects

Only Documents support versioning. Other object types, such as Items, Folders, and Relationships, do not have versioning capabilities.

Each versioned document is part of a Version Series – a collection of all versions of the document. All documents in a single version series share the same Version Series ID. However, each version is technically a separate object with a unique Object ID.

The version format follows <major>.<minor>, such as 1.0, 1.1, and 2.0:

• The major part starts at 1 and increments with each major version.
• The minor part starts at 0 for each major version and increments with every minor update within that major version.
• A version with a .0 minor part (<major>.0) is considered a Major Version.
• The highest major version of a document is the Latest Major Version.
• The highest combined major and minor version is the Latest Version.

A document is created as either a major or a minor version, depending on the Versioning State parameter:

• major - created as a major version with version 1.0.
• minor - created as a minor version with version 0.1.

Versioning-Specific Properties

Documents have a set of versioning-related properties. These properties cannot be updated directly but are automatically managed during versioning operations.

Check Document Specific Properties for an overview on all properties available for documents.

Versioning Flow

Updating a document with any Update Operation won't automatically create a new version.

Creating a new version involves the following steps:

1. Check-Out: Creates a Private Working Copy of the document, a temporary editable copy that is not yet a new version.
2. Optionally, apply any updates to the Private Working Copy.
3. Check-In: Saves the Private Working Copy as a new version. During check-in, the version label is incremented, and depending on parameters, either the major or minor version increases.

Alternatively, Cancel Check-Out discards any prepared changes and deletes the Private Working Copy.

Versioning Operations

curl -X 'POST' \
  '{REPOSITORY_URL}/Animals/Dogs/Rex' \
  -H 'Content-Type: application/json' \
  -d '{
    "operation": "checkOut",
    "succinct": true
  }'

{
  "succinctProperties": {
    "cmis:name": "Rex",
    "cmis:objectId": "2f14b215-32ce-497d-bbea-e8e58c1971bc",
    "cmis:objectTypeId": "dog",
    "cmis:description": "Good Dog!",
    "cmis:isPrivateWorkingCopy": true
  }
}

curl -X 'POST' \
  '{REPOSITORY_URL}/Animals/Dogs/Rex_pwc' \
  -H 'Content-Type: application/json' \
  -d '{
  "operation": "checkIn",
  "succinct": "true",
  "major": false,
  "checkinComment": "A new minor version",
  "properties": {
    "cmis:description": "Best Dog!"
  }
}'

{
  "succinctProperties": {
    "cmis:name": "Rex",
    "cmis:objectId": "2f14b215-32ce-497d-bbea-e8e58c1971bc",
    "cmis:objectTypeId": "dog",
    "cmis:description": "Best Dog!",
    "cmis:isPrivateWorkingCopy": false,
    "cmis:versionLabel": "1.1"
  }
}

curl -X 'POST' \
  '{REPOSITORY_URL}/Animals/Dogs/Rex_pwc' \
  -H 'Content-Type: application/json' \
  -d '{
  "operation": "cancelCheckOut"
}'

curl -X 'GET' \
  '{REPOSITORY_URL}/Animals/Dogs/Rex/versions' 

[
  {
    "succinctProperties": {
      "cmis:name": "Rex",
      "cmis:objectId": "2f14b215-32ce-497d-bbea-e8e58c1971bc",
      "cmis:versionLabel": "1.0",
      "cmis:isLatestMajorVersion": true
    }
  },
  {
    "succinctProperties": {
      "cmis:name": "Rex",
      "cmis:objectId": "4d21a256-47de-432c-bf8c-a3e7b7e5a432",
      "cmis:versionLabel": "1.1",
      "cmis:isLatestVersion": true
    }
  }
]