Querying All API Versions

Function

This API is used to query all API versions supported by CTS.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters
Parameter	Type	Description
version	Array of Version objects	Indicates the lists of all API versions.

Table 2 Version
Parameter	Type	Description
id	String	Identifies a version. An example version ID is v1.
links	Array of LinksBody objects	Indicates an API URL.
version	String	If microversions are supported, set this parameter to the maximum microversion supported. Otherwise, leave this parameter empty.
status	String	Indicates the version status. Possible values are CURRENT (widely used version), SUPPORTED (earlier version which is still supported), and DEPRECATED (deprecated version which may be deleted later). Enumeration values: CURRENT SUPPORTED DEPRECATED
updated	String	Indicates the Coordinated Universal time (UTC) time when the version was released. For example, the value is 2014-06-28T12:20:21Z for v1.
min_version	String	If microversions are supported, set this parameter to the minimum microversion supported. Otherwise, leave this parameter empty.

Table 3 LinksBody
Parameter	Type	Description
href	String	Indicates an address referenced by the current API version.
rel	String	Indicates the relationship between the current API version and the referenced address.

Example Requests

None

Example Responses

Status code: 200

The request is successful.

{
  "version" : [ {
    "id" : "v1.0",
    "links" : {
      "href" : "https://x.x.x.x/v1.0/",
      "rel" : "self"
    },
    "min_version" : "",
    "status" : "CURRENT",
    "updated" : "2018-09-30T00:00:00Z",
    "version" : ""
  }, {
    "id" : "v2.0",
    "links" : {
      "href" : "https://x.x.x.x/v2.0/",
      "rel" : "self"
    },
    "min_version" : "",
    "status" : "SUPPORTED",
    "updated" : "2018-09-30T00:00:00Z",
    "version" : ""
  } ]
}

Status Codes

Status Code	Description
200	The request is successful.
404	The server failed to find the requested resource.
500	The server encountered an unexpected condition which prevented it from fulfilling the request.

Error Codes

See Error Codes.

Parent topic: API Version Management

Предыдущая статья

API Version Management

Следующая статья

Querying a Specific API Version

Была ли эта статья полезна?

Поддержка Юридические документы