Jump to

• Request
• Response
• Examples

Get v1.1 API information

get

/content/preview/api/v1.1

Returns information about the v1.1 API.
A version resource has the following properties:

1. version: Version of the resource.
2. lifecycle: Whether a version is actively supported or deprecated.
3. isLatest: Whether it is the latest version.
4. terminationDate (Optional): Date of termination.
5. catalog: A child resource that serves as a metadata catalog for all the resources supported in that version.

Headers (Optional):

Header Name	Header Value
Accept	application/json

Request

Query Parameters

• links(optional): string
  Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
  Example: links=self,canonical will only return the links with the rel property self or canonical.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : Version

Type: object

Version.

Show Source

• catalog: object Version
  Version.
• isLatest: boolean
  Whether it is latest version.
• lifecycle: string
  Whether a version is actively supported or deprecated.
• links: array links
  Links of the resource.
• terminationDate (optional): string(date-time)
  When a version is not supported anymore.
• version: string
  Version of the resource.

{
    "type":"object",
    "required":[
        "catalog",
        "isLatest",
        "lifecycle",
        "links",
        "version"
    ],
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the resource."
        },
        "lifecycle":{
            "type":"string",
            "description":"Whether a version is actively supported or deprecated."
        },
        "isLatest":{
            "type":"boolean",
            "description":"Whether it is latest version."
        },
        "catalog":{
            "description":"A child resource that serves as a metadata catalog for all the resources supported in the version.",
            "$ref":"#/definitions/Version"
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "terminationDate ":{
            "type":"string",
            "format":"date-time",
            "description":"When a version is not supported anymore."
        }
    },
    "description":"Version."
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

403 Response

Forbidden. Client is not authorized to perform this request.

500 Response

Internal server error. An unexpected error condition encountered in the system.

Back to Top

Examples

Example:

The following example shows how to get v1.1 Preview API by submission of a GET request on the REST resource using cURL:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/preview/api/v1.1' 

This reads information of v1.1 preview API.

Response Body

{
        "version": "v1.1",
        "lifecycle": "active",
        "isLatest": true,
        "catalog": {
          "links": [
            {
              "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog",
              "rel": "canonical",
              "method": "GET",
              "mediaType": "application/json"
            }
          ]
        },
        "links": [
          {
            "href": "https://<hostname>/content/preview/api/v1.1",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/v1.1/metadata-catalog",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          }
        ]
      }

Back to Top