Querying API Versions¶

Function¶

This API is used to query all available API versions of the BMS service.

URI¶

GET /

Request Parameters¶

None

Example Request¶

Querying all available API versions

GET https://{BMS Endpoint}/

Response Parameters¶

Parameter	Type	Description
versions	Array of objects	Specifies API versions of the BMS service. For details, see Table 1.

**Table 1** versions data structure¶
Parameter	Type	Description
id	String	Specifies the API version ID.
links	Array of objects	Specifies the API URL. For details, see Table 2.
min_version	String	Specifies the earliest micro API version that is supported.
status	String	Specifies the API version status. CURRENT: indicates a primary version. SUPPORTED: indicates an earlier version which is still supported. DEPRECATED: indicates a deprecated version which may be deleted later.
updated	String	Specifies the release date of an API version. The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2018-09-30T00:00:00Z.
version	String	Specifies the latest micro API version that is supported.

**Table 2** links data structure¶
Parameter	Type	Description
href	String	Specifies the API URL.
rel	String	Specifies the API URL dependency. The value can be: self: resource link that contains the version number. It is used when immediate tracing is required. bookmark: resource link that can be stored for a long time.

Example Response¶

{
    "versions": [
        {
            "id": "v1",
            "links": [
                {
                    "href": "http://bms.xxx.com/v1/",
                    "rel": "self"
                }
            ],
            "min_version": "",
            "status": "CURRENT",
            "updated": "2018-09-30T00:00:00Z",
            "version": ""
        }
    ]
}

Returned Values¶

Normal values

Returned Values	Description
200	The request has been successfully processed.

For details about other returned values, see Status Codes.

Error Codes¶

See Error Codes.

last updated: 2025-08-29 16:30 UTC - commit: 6208da1405127a92288439a4036df6cbd1f73d26