Get v1.1 API Information
get
/content/published/api/v1.1
Returns information about the v1.1 API.
A version resource has the following properties:
A version resource has the following properties:
- version: Version of the resource.
- lifecycle: Whether a version is actively supported or deprecated.
- isLatest: Whether it is the latest version.
- terminationDate (Optional): Date of termination.
- catalog: A child resource that serves as a metadata catalog for all the resources supported in that version.
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.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
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.
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
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.
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 v1.1 API information.
curl -i -X GET -H "Accept:application/json" 'http://<hostname>/content/published/api/v1.1'
Example
Gets information of v1.1 delivery API.
/content/published/api/v1.1
Response Body
{ "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": "self", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/published/api/v1.1", "rel": "canonical", "method": "GET", "mediaType": "application/json" }, { "href": "https://<hostname>/content/published/api/v1.1/metadata-catalog", "rel": "describedby", "method": "GET", "mediaType": "application/schema+json" } ] }