Jump to

• Request
• Response
• Examples

Get available versions of the Content Preview API

get

/content/preview/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 Name	Header Value
Accept	application/json

Request

Query Parameters

• limit(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the size of the result. The maximum value allowed for limit is 500.

  Default Value: 100
• 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, first, last, prev, next.
  Example: links=self,canonical will only return the links with the rel property self or canonical.
• offset(optional): integer(int32)
  Start index of response rows.

  Default Value: 0
• totalResults(optional): boolean
  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

• application/json

200 Response

Successful operation.

Body ()

Root Schema : CollectionProperties

Type: object

CollectionProperties.

Show Source

• aggregationResults(optional): array aggregationResults
  Aggregation results.
• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Check whether there are more pages to fetch.
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int32)
  Actual page size used by the server. This might not be the same as what the client requests.
• links(optional): array links
  Links of the resource.
• offset(optional): integer(int32)
  The actual index from which the singular resources are returned.
• pinned(optional): array pinned
  Pinned items. Shows items pinned at the top of search list
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  additional collection properties.
• scrollId(optional): string
  scrollId if the search resolved to a scroll search.
• totalResults(optional): integer(int32)
  Total number of rows that satisfy the client request (excluding the paging parameters.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "properties":{
            "type":"object",
            "description":"additional collection properties.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "type":"object"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"CollectionProperties."
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "type":"object"
    }
}

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 : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"additional collection properties.",
    "additionalProperties":{
        "type":"object"
    }
}

additional collection properties.

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : items

Type: object

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."
}

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

Example:

The following example shows how to get available versions of 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'

This reads available versions of Content Preview API.

Response Body

{
        "offset": 0,
        "limit": 1,
        "count": 1,
        "hasMore": false,
        "links": [
          {
            "href": "https://<hostname>/content/preview/api",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/preview/api/metadata-catalog",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/preview/api?offset=0",
            "rel": "first"
          },
          {
            "href": "https://<hostname>/content/preview/api?offset=0",
            "rel": "last"
          }
        ],
        "aggregationResults": null,
        "items": [
          {
            "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": "canonical",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ]
      }

Back to Top