Retrieving and displaying the versions of a DMS object

Released: JSON representation, HTML page

You can retrieve the versions of a DMS object as JSON representations or display the versions of a DMS object.

To retrieve or display the versions of a DMS object, you must perform the following steps:

Determine the link relation for retrieving and displaying the versions of a DMS object
Open the URL for the versions of a DMS object

Determine the link relation for retrieving and displaying the versions of a DMS object

In the chapter Retrieving and viewing the details of a DMS object, you can learn how to determine the link relation for the versions of a DMS object.

Retrieving and displaying the versions of a DMS object (JSON representation)

Once you have the URL of the versions from the link relation, then you can retrieve the versions of a DMS object as follows:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/
Accept: application/json
Accept-Language: en

The following JSON object will then be returned as a result:

Response

{
  "_links": {
    "self": {
      "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/"
    }
  },
  "versions": [{ 
      "_links": { 
        "mainblobcontent": { 
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/6_3/b/main/c" 
        },
        "pdfblobcontent": {
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/6_3/b/p1/c"
        },
        "self": { 
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/6_3"
        }
      },
      "alterationText": "",
      "caption": "3 Processing",
      "creationDate":"2019-10-25T12:22:56.000+02:00",
      "id": "6_3",
      "mimeType":"application/msword",
      "state":"Processing"
    },
    {
      "_links": { 
        "mainblobcontent": { 
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/3_2/b/main/c" 
        },
        "pdfblobcontent": {
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/3_2/b/p1/c"
        },
        "self": { 
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/3_2"
        }
      },
      "alterationText": "Reasons for changes",
      "caption": "2 Release",
      "creationDate":"2019-10-22T16:29:32.000+02:00",
      "id": "3_2",
      "mimeType":"application/msword",
      "state":"Released"
    },
    {
      "_links": { 
        "mainblobcontent": { 
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/1_1/b/main/c" 
        },
        "pdfblobcontent": {
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2/D000000123/v/1_1/b/p1/c"
        },
        "self": { 
          "href": "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/1_1"
        }
      },
      "alterationText": "Reasons for changes",
      "caption": "1 Archive",
      "creationDate":"2019-10-12T11:49:41.000+02:00",
      "id": "1_1",
      "mimeType":"application/msword",
      "state":"Archived"
    }
  ]
}

Property	Description
`_links`	Contains the link relations: `self`: Self-link
`versions`	Specifies the array with the versions.

Property

Description

_links

Contains the link relations:

self: Self-link

versions

Specifies the array with the versions.

Structure of a version

Property	Description
`_links`	Contains the link relations for the version of a DMS object. `mainblobcontent`: Relative download URL for the main document of the DMS object version. `pdfblobcontent:` Relative download URL for the dependent PDF document of the version of the DMS object. You will only receive this URL if a dependent PDF document has been created for the DMS object. `self`: Self-link.
`alterationText`	Specifies the alteration text for the release of the version.
`caption`	Specifies the display name of the version. This value is output for the specific language by evaluating the `Accept-Language` HTTP header.
`creationDate`	Specifies the creation date of the version.
`id`	Specifies the ID of the version.
`mimeType`	Specifies the type of the main document.
`state`	Specifies the status of the version. The values available are `Processing`, `Verification`, `Released` and `Archived`.

Retrieving and displaying the versions of a DMS object (HTML page)

If you want to call the HTML view of the versions, determine the link relation for the versions of a DMS object. Enter the URL in the browser to view the HTML page. This HTML page contains the list of the versions of a DMS object.

Example:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/o2m/D000000123/v/
Accept: text/html

Retrieving and saving the notes of a DMS object

Linking DMS objects