Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use this API method to obtain the attributes (metadata) of a specific document version. The result is in JSON format and contains the list of attributes along with their values.

Request URL

The request URL takes the following form:
GET <ROOT>/rest/stonikbyte-documents-api/1.0/document/{documentID}/version/{versionNumber}

Parameters

Parameter

Description

{documentID}

The Id (key) of the document

{versionNumber}

The version number

A successful response

An HTTP 200 status response indicates a successful request. Here is an example of data returned in JSON format:

...

You can form links to download the file of a specific document version by using the documentKey and versionNumber. The link is in form:
https:/ /MY_JIRA_BASE_URL/plugins/servlet/StonikByte/VersionOfDocument?documentId=519&versionNumber=2
In this example, the file attached to version 2 of the document 519 will be downloaded.

Error Response

If the REST call fails, the service returns one of the following HTTP statuses:

...