L'API de contrôle Havenask renvoie un corps de réponse unifié, que la requête aboutisse ou échoue.
Réponse en cas de succès
Exemple :
{
"requestId": "D77D0DAF-790D-F5F5-A9C0-133738165014",
"result": (Array|Object) // Returned data
}Remarque
Une requête GET réussie renvoie les données de réponse dans le champ result. Une requête POST ou DELETE réussie renvoie {} ou [] dans le champ result.
Structure :
|
Champ |
Type |
Description |
|
|
requestId |
String |
ID de la requête |
|
|
result |
Array \ |
Object |
Données renvoyées |
Réponse d'erreur
Exemple :
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"code": "instance.NotFound",
"message": "Instance not found"
}Structure :
|
Champ |
Type |
Description |
|
requestId |
String |
ID de la requête |
|
code |
String |
Code d'erreur |
|
message |
String |
Message d'erreur |
Pour plus d'informations, consultez la page Codes d'erreur.