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) :
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
Response
Supported Media Types
- application/json
200 Response
Successful operation.
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: additionalPropertiesadditional 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.)
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
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 : 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.
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.
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" } ] } ] }