Consulta de una versión de API
Función
Esta API se utiliza para consultar una versión de API especificada del servicio del BMS.
Parámetros de solicitud
No hay
Ejemplo de solicitud
1
|
GET https://{BMS Endpoint}/v1 |
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
version |
Object |
Especifica una versión de API especificada del servicio de BMS. Para más detalles, consulte Tabla 2. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de versión de la API. |
links |
Array of objects |
Especifica la URL de la API. Para obtener más información, véase Tabla 3. |
min_version |
String |
Especifica la versión más antigua de la micro API que se admite. |
status |
String |
Especifica el estado de la versión de la API.
|
updated |
String |
Especifica la fecha de lanzamiento de una versión de API. El formato de marca de tiempo es AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por ejemplo, 2018-09-30T00:00:00Z. |
version |
String |
Especifica la versión más reciente de la micro API que se admite. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
Especifica el URL de la API. |
rel |
String |
Especifica la dependencia URL de la API. El valor puede ser:
|
Ejemplo de respuesta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
{ "version": { "id": "v1", "links": [ { "href": "http://bms.xxx.com/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2018-09-30T00:00:00Z", "version": "" } } |
Valores devueltos
Valor de retorno |
Descripción |
---|---|
200 |
La solicitud se ha procesado correctamente. |
Para obtener más información sobre otros valores devueltos, consulte Códigos de estado.
Códigos de error
Véase Códigos de error.