Erreurs
Objet d'erreur
En cas d'échec, l'API renvoie un objet error, soit au niveau supérieur de la réponse (tout l'appel a échoué), soit sur une instance individuelle (cette valeur précise a échoué). La structure est la même dans les deux cas.
{
"error": {
"code": "string",
"message": "string"
}
}| Champ | Type | Description |
|---|---|---|
code | GUID | Identifiant stable de l'erreur. |
message | string | Description lisible par un humain. |
Faites la correspondance sur code, pas sur message. Les codes sont des GUID stables ; les messages sont des textes descriptifs susceptibles de changer et peuvent interpoler des valeurs de la requête (par exemple, No rights context defined for Guid = '...').
{
"error": {
"code": "3f567979-e5b7-4725-8b93-9363ceaa5604",
"message": "Undefined Rights Context"
}
}Deux niveaux d'erreur
Les erreurs sont signalées à deux niveaux.
Une erreur au niveau de la réponse renvoie un HTTP 400 avec un corps error de niveau supérieur. Tout l'appel a été rejeté ; rien n'a été transformé.
Une erreur au niveau de l'instance renvoie un HTTP 200 avec une ou plusieurs instances portant un objet error et une value à null. Les autres instances peuvent tout de même avoir réussi, donc inspectez toujours value et error pour chaque instance.
Codes de statut HTTP
| Code | Signification |
|---|---|
200 | Requête traitée. Inspectez chaque instance à la recherche d'une error par instance. |
400 | Requête rejetée : corps mal formé, champs requis manquants, configuration inconnue, ou problème de compte/quota (voir les codes ci-dessous). |
401 | Jeton manquant, expiré ou invalide. La réponse porte un en-tête WWW-Authenticate: Bearer error="invalid_token" et aucun corps. Réauthentifiez-vous. |
Codes d'erreur au niveau de la réponse
Ceux-ci rejettent l'intégralité de l'appel avec un 400 Bad Request et un error de niveau supérieur.
| Condition | message | code |
|---|---|---|
| Configuration introuvable ou désactivée | Configuration not found | df7817ea-b5b6-4933-b8da-ce28fff582e9 |
| Compte introuvable | Account not found | 151a7cb0-9b13-494f-996c-0c7eee2bfd08 |
| Compte suspendu ou désactivé | Account status is not active | ecae14fc-b6fa-4e13-8ca3-cb85f21bd015 |
| Le solde du compte n'a aucun crédit | Account has no credits | 368b13a8-9cda-4a8e-b646-dd837f9f504e |
| Limite quotidienne de transformations dépassée | Daily transformation limit exceeded | 9ca42676-423a-4384-805a-0b671afecc4b |
| Limite mensuelle de transformations dépassée | Monthly transformation limit exceeded | da593b4c-277e-440c-956e-3a6e7737b565 |
| Format de requête incorrect ou champ requis manquant | Wrong request format | d60c07f8-acb0-4125-82fe-d3577d7eec98 |
| La requête ne référence aucun Rights Context | Request = '{request.Guid}' has no rights context definition | c0804f15-1632-4d54-8154-5b63f0ebbe1d |
| Le Rights Context référencé n'a aucune définition de preuve | No rights context defined for Guid = '{request.RightsContext}' | c0804f15-1632-4d54-8154-5b63f0ebbe1d |
| Le Processing Context référencé n'a aucune définition de preuve | No processing context defined for Guid = '{request.ProcessingContext}' | c0804f15-1632-4d54-8154-5b63f0ebbe1d |
Codes d'erreur au niveau de l'instance
Ceux-ci renvoient un HTTP 200 avec value: null sur l'instance concernée. Les autres instances du même appel peuvent tout de même réussir.
| Condition | message | code |
|---|---|---|
| Aucun Processing Context spécifié pour la requête | Processing Context required | 118f797c-5f6f-4c46-a48f-4d1a9fb38f21 |
| GUID de Processing Context non renvoyé par la configuration | Undefined Processing Context | 11b34d01-1425-489d-9665-2acd24e2922c |
| Processing Context absent de la configuration | Processing Context not found | 8d39bc4c-8698-4f7b-a4f8-ba74b593f86e |
| Le Processing Context n'a aucune Transformer Sequence | Undefined Sequence | 978c46c6-5859-40e9-be71-bd9ca4badd1c |
| Séquence référencée absente de la configuration | Sequence not found | 3f63a7bc-39d9-4671-83a1-6f17595c0d03 |
| La séquence ne contient pas le transformer extract requis | Required transformer not found | 98f54c8f-d339-4b18-a524-90c53882be71 |
| GUID de Rights Context non renvoyé par la configuration | Undefined Rights Context | 3f567979-e5b7-4725-8b93-9363ceaa5604 |
| Rights Context absent de la configuration | Rights Context not found | f800df3c-4288-4591-9b7b-64eff20ff9ed |
| Le Rights Context n'a aucun droit attribué pour la propriété | Undefined Rights Context | 2f01b281-35eb-414b-85c2-b642ebde542f |
| Aucun Processing Context spécifié pour détecter la séquence de transformation | Processing Context required | a81e9f99-b934-409c-b26d-78f2455a9ec7 |
La plupart des erreurs au niveau de l'instance pointent vers une incohérence de configuration entre les GUID que votre requête référence et ce que le portail a mis en service. Vérifiez que les GUID rightsContext et processingContext de votre requête correspondent à des contextes qui existent, sont activés et accordent des droits sur les Data Instances demandées.