Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>

2024-07-04 11:26:33 +00:00

11 KiB

Raw Blame History

Querying Version Information of an API

Function

This API is used to query version information of a specified API.

URI

GET https://{Endpoint}/{versionId}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
versionId	Yes	String	API version

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
version	ApiVersionResponse object	API version information

**Table 3** ApiVersionResponse
Parameter	Type	Description
id	String	API version number
links	Array of Links objects	API link information NOTE: If the version is v3, the value is [].
status	String	Version status
version	String	Subversion information of the API version
min_version	String	Minimum API version number
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 4** Links
Parameter	Type	Description
href	String	API URL. The value is "".
rel	String	The value is self, indicating that URL is a local link.

Example Requests

URI example

GET https://{Endpoint}/v3

Example Response

Status code: 200

Success

{
  "version" : {
    "id" : "v3",
    "links" : [ ],
    "status" : "CURRENT",
    "version" : "",
    "min_version" : "",
    "updated" : "2019-10-30T17:34:02Z"
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: API Versions

11 KiB Raw Blame History