doc-exports/docs/ddm/api-ref/ddm_api_01_0108.html

Querying API Versions (a V3 API)

Function

This API is used to query API versions.

Constraints

None

URI

• URL format

GET /

• Parameter description

  None

Request Parameters

None

Example Request

Querying API versions

GET https://ddm.eu-de.otc.t-systems.com/ 

Response

• Normal response

Table 1 Response body parameters

Parameter	Type	Description
versions	Array of ApiVersion objects	API version information including links.

Table 2 ApiVersion

Parameter	Type	Description
id	String	API version, for example, v1 or v3.
links	Array of LinkInfo objects	API link information. The value is empty when the version is v1 or v3.
status	String	Version status. CURRENT: recommended version. SUPPORTED: earlier version which is still supported. DEPRECATED: deprecated version which may be deleted later.
version	String	If microversions are supported by APIs of the given version, the maximum microversion supported will be displayed. If microversions are not supported, this field will be empty.
updated	String	Version update time. The format is yyyy-mm-dd Thh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.

Table 3 LinkInfo

Parameter	Type	Description
href	String	URL of the API.
rel	String	Its value is self, indicating that href is a local link.

• Normal response example

{
  "versions": [
    {
      "id": "v3",
      "links": [],
      "status": "CURRENT",
      "updated": "2019-01-15T12:00:00Z",
      "version":""
    },
    {
      "id": "v1",
      "links": [],
      "status": "DEPRECATED",
      "updated": "2017-02-07T17:34:02Z",
      "version":""
    }
  ]
}

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Querying API Versions