Get Available Versions of an API

get

/content/published/api

Returns information about the available versions of the API.
It is a collection resource, and each item within the collection is a version resource.

Headers (Optional) :
Header NameHeader Value
Acceptapplication/json

Request

Query Parameters
  • Number of rows to return.
    Default Value: 100
  • Start index of response rows.
    Default Value: 0
  • Accepts a Boolean value. Setting it to true displays the total results field in the response.
    Default Value: false
Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : CollectionProperties
Type: object
CollectionProperties.
Show Source
Nested Schema : aggregationResults
Type: array
Aggregation results.
Show Source
Nested Schema : items
Type: array
Singular resources contained in the collection.
Show Source
Nested Schema : pinned
Type: array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
additional collection properties.
Nested Schema : AggregationResult
Type: object
Show Source
Nested Schema : items
Type: object
Nested Schema : additionalProperties
Type: object

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

The following example shows how to get available versions of API.

curl -i -X GET -H "Accept:application/json" 'http://<hostname>/content/published/api'
Example

Gets available versions of content delivery API.

/content/published/api

Response Body

{
        "offset": 0,
        "limit": 1,
        "count": 1,
        "hasMore": false,
        "links": [
          {
            "href": "https://<hostname>/content/published/api",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/published/api/metadata-catalog",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/published/api?offset=0",
            "rel": "first"
          },
          {
            "href": "https://<hostname>/content/published/api?offset=0",
            "rel": "last"
          }
        ],
        "items": [
          {
            "version": "v1.1",
            "lifecycle": "active",
            "isLatest": true,
            "catalog": {
              "links": [
                {
                  "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog",
                  "rel": "canonical",
                  "method": "GET",
                  "mediaType": "application/json"
                }
              ]
            },
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1",
                "rel": "canonical",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ]
      }
Back to Top