REST API for Content Management 1.1

Get Specific Version

get

/documents/api/{version}

Get information for the specified version of the API. The version resource provides information about all available versions or about a specific version of the API itself.

Request

Supported Media Types

application/json
application/xml

Path Parameters

version: Type: string

Required: true

Version value

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

Body

Version information.

Root Schema : VersionDefinition

Version information.

Properties

catalog: Type: object APILinks

Additional Properties Allowed:

API links information.
isLatest: Type: string

Indicates whether it is the latest version (true) or not (false).
lifecycle: Type: string

Indicates whether the version is active or deprecated. The default value is active.
links: Type: array links

Additional Properties Allowed:

List of Links.
terminationDate: Type: string

Indicates when the version will no longer be supported.
version: Type: string

Version identifier.

Nested Schema : APILinks

API links information.

Properties

href: Type: string

Complete URL that uniquely defines the resource.
ref: Type: string

Relationship.

Nested Schema : links

Type: array

List of Links.

Items

Type: object APILinks

Additional Properties Allowed:

API links information.

Example application/json


{
    "items":[
        {
            "version":"1.1",
            "lifecycle":"active",
            "isLatest":"false",
            "catalog":{
                "links":[
                    {
                        "ref":"canonical",
                        "href":"https://www.example.com/documents/api/1.1/metadata-catalog"
                    }
                ]
            },
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.1"
                }
            ]
        }
    ]
}

Examples

The following example returns information for the specified version.

GET .../api/1.1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "version": "1.1",
    "lifecycle": "active",
    "isLatest": true,
    "catalog": {
        "links": [
            {
                "ref": "canonical",
                "href": "https://www.example.com/documents/api/1.1/metadata-catalog"
            }
        ]
    },
    "links": [
        {
            "ref": "canonical",
            "href": "https://www.example.com/documents/api/1.1"
        }
    ]
}