Jump to

• Request
• Response
• Examples

Get All Versions

get

/documents/api/

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

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : VersionsResponse

Type: object

The response body includes information about the API versions operation.

Show Source

• links(optional): array links
  List of Versions.

{
    "description":"The response body includes information about the API versions operation.",
    "properties":{
        "links":{
            "type":"array",
            "description":"List of Versions.",
            "items":{
                "$ref":"#/definitions/VersionDefinition"
            }
        }
    }
}

Nested Schema : links

Type: array

List of Versions.

Show Source

• Array of: object VersionDefinition
  Version information.

{
    "type":"array",
    "description":"List of Versions.",
    "items":{
        "$ref":"#/definitions/VersionDefinition"
    }
}

Nested Schema : VersionDefinition

Type: object

Version information.

Show Source

• catalog(optional): object APILinks
  API links information.
• isLatest(optional): string
  Indicates whether it is the latest version (true) or not (false).
• lifecycle(optional): string
  Indicates whether the version is active or deprecated. The default value is active.

• links(optional): array links
  List of Links.
• terminationDate(optional): string
  Indicates when the version will no longer be supported.
• version(optional): string
  Version identifier.

{
    "description":"Version information.",
    "properties":{
        "version":{
            "type":"string",
            "description":"Version identifier."
        },
        "lifecycle":{
            "type":"string",
            "description":"Indicates whether the version is <code>active</code> or <code>deprecated</code>. The default value is <code>active</code>.</p>"
        },
        "isLatest":{
            "type":"string",
            "description":"Indicates whether it is the latest version (<code>true</code>) or not (<code>false</code>)."
        },
        "terminationDate":{
            "type":"string",
            "description":"Indicates when the version will no longer be supported."
        },
        "catalog":{
            "$ref":"#/definitions/APILinks"
        },
        "links":{
            "type":"array",
            "description":"List of Links.",
            "items":{
                "$ref":"#/definitions/APILinks"
            }
        }
    }
}

Nested Schema : APILinks

Type: object

API links information.

Show Source

• href(optional): string
  Complete URL that uniquely defines the resource.
• ref(optional): string
  Relationship.

{
    "description":"API links information.",
    "properties":{
        "ref":{
            "type":"string",
            "description":"Relationship."
        },
        "href":{
            "type":"string",
            "description":"Complete URL that uniquely defines the resource."
        }
    }
}

Nested Schema : links

Type: array

List of Links.

Show Source

• Array of: object APILinks
  API links information.

{
    "type":"array",
    "description":"List of Links.",
    "items":{
        "$ref":"#/definitions/APILinks"
    }
}

Example Response (application/json)

{
    "items":[
        {
            "version":"1.0",
            "lifecycle":"active",
            "isLatest":"false",
            "catalog":{
                "links":[
                    {
                        "ref":"canonical",
                        "href":"https://www.example.com/documents/api/1.0/metadata-catalog"
                    }
                ]
            },
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.0"
                }
            ]
        },
        {
            "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"
                }
            ]
        },
        {
            "version":"1.2",
            "lifecycle":"active",
            "isLatest":"true",
            "catalog":{
                "links":[
                    {
                        "ref":"canonical",
                        "href":"https://www.example.com/documents/api/1.2/metadata-catalog"
                    }
                ]
            },
            "links":[
                {
                    "ref":"canonical",
                    "href":"https://www.example.com/documents/api/1.2"
                }
            ]
        }
    ]
}

Back to Top

Examples

The following example returns all currently available versions of the API.

GET .../api

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "items": [
        {
            "version": "1.0",
            "lifecycle": "active",
            "isLatest": false,
            "catalog": {
                "links": [
                    {
                        "ref": "canonical",
                        "href": "https://www.example.com/documents/api/1.0/metadata-catalog"
                    }
                ]
            },
            "links": [
                {
                    "ref": "canonical",
                    "href": "https://www.example.com/documents/api/1.0"
                }
            ]
        },
        {
            "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"
                }
            ]
        },
        {
            "version" : "1.2",
            "lifecycle" : "active",
            "isLatest" : true,
            "catalog" : {
                "links" : [
                    {
                        "ref" : "canonical",
                        "href" : "http://www.example.com/documents/api/1.2/metadata-catalog"
                    }
                ]
            },
            "links" : [
                {
                    "ref" : "canonical",
                    "href" : "http://www.example.com/documents/api/1.2"
                }
            ]
        }
    ]
}

Back to Top