Obtenção de detalhes de versões da API
Função
Essa API é usada para consultar os detalhes de versões da API do DSS.
URI
GET /
Solicitação
Resposta
Parâmetros de resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
versions |
Array |
Especifica as informações de versão da API. |
id |
String |
Especifica o ID da versão, por exemplo, v1. |
links |
Array of objects |
Especifica o URL da API. Para mais detalhes, consulte Tabela 2. |
version |
String |
Especifica a microversão máxima suportada por essa API. |
status |
String |
Especifica o status da versão. O valor pode ser o seguinte: CURRENT: indica que a versão é atualmente recomendada para uso. SUPPORTED: indica que a versão é uma versão anterior, mas ainda é suportada. DEPRECATED: indica uma versão obsoleta que pode ser excluída posteriormente. |
updated |
String |
Especifica a hora em que a versão da API foi lançada. Formato da hora: UTC YYYY-MM-DDTHH:MM:SS |
min_version |
String |
Especifica a microversão mínima suportada por essa API. |
Parâmetros no campo links
- Exemplo de resposta
{ "versions": [ { "min_version": "", "links": [ { "rel": "self", "href": "https://dss.localdomain.com/v1" } ], "id": "v1", "updated": "2014-06-28T12:20:21Z", "version": "", "status": "SUPPORTED" }, { "min_version": "", "links": [ { "rel": "self", "href": "https://dss.localdomain.com/v2" } ], "id": "v2", "updated": "2014-06-28T12:20:21Z", "version": "", "status": "CURRENT" } ] }
Valores retornados
- Normal
- Anormal
Consulte Descrição do código de erro.
Códigos de erro
Consulte Códigos de erro.