A API de controle do Havenask retorna um corpo de resposta unificado para requisições bem-sucedidas e com falha.
Resposta de sucesso
Exemplo:
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": (Array|Object) // Returned data
}Nota
Uma requisição GET bem-sucedida retorna os dados no campo result. Requisições POST ou exclua bem-sucedidas retornam {} ou [] no campo result.
Estrutura:
|
Campo |
Tipo |
Descrição |
|
|
requestId |
String |
ID da requisição |
|
|
result |
Array \ |
Object |
Dados retornados |
Resposta de erro
Exemplo:
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"code": "instance.NotFound",
"message": "Instance not found"
}Estrutura:
|
Campo |
Tipo |
Descrição |
|
requestId |
String |
ID da requisição |
|
code |
String |
Código de erro |
|
message |
String |
Mensagem de erro |
Para obter mais informações, consulte Códigos de erro.