Help Center> ROMA Connect> API Reference> Public Resource APIs> Public Management> Obtaining the API Version of a Given Version ID
View PDF

Obtaining the API Version of a Given Version ID

Function

This API is used to obtain the API version of a given version ID.

URI

GET /{version}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

version

Yes

String

Version.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

version

Version object

Version.
Table 3 Version

Parameter

Type

Description

id

String

API version ID, for example, v1.

Minimum: 1

Maximum: 128

version

String

Maximum microversion of the API. This parameter is left blank if the microversion is not supported.

Minimum: 1

Maximum: 128

min_version

String

Minimum microversion of the API. This parameter is left blank if the microversion is not supported.

Minimum: 1

Maximum: 128

status

String

API version status.

  • The options are as follows:

  • CURRENT: recommended version.

  • SUPPORTED: an old version that is still supported.

  • DEPRECATED: deprecated version, which may be deleted later.

updated

Number

UTC time when the API version was released.

Minimum: 1

Maximum: 128

links

Array<Object>

URL of the API version.
Table 4 links

Parameter

Type

Description

rel

String

Usage.

href

String

URL for this usage.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "version" : {
    "min_version" : "",
    "links" : [ {
      "rel" : "self",
      "href" : "https://roma.example.com/v2"
    } ],
    "id" : "v2",
    "updated" : "2020-06-28T12:20:21Z",
    "version" : "",
    "status" : "CURRENT"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Public Management