Schémas de requêtes et de réponse

Le résultat que nous récupérons en utilisant des API asynchrones peut être Traitement (Processing), Réussite (Successful) ou Peut rencontrer des erreurs (May encounter failures). Cette page décrit les schémas couramment renvoyés pour ces deux situations lorsqu’un appel getResult est effectué. Apprendre à déchiffrer ces résultats est essentiel pour une gestion et un dépannage réussis des API.

Traitement

Lors du traitement, l’appel getResult renvoie un schéma avec les détails suivants :

• status : le statut actuel de la requête. Dans ce cas, le statut est Running.
• createdAt : date et heure du lancement de la requête.
• lastUpdatedAt : date et heure de la dernière muse à jour de la requête.

réussie

Lorsque la requête réussit, l’appel getResult renvoie un schéma avec les détails suivants :

• status : le statut actuel de la requête. Dans ce cas, le statut est Succeeded.
• createdAt : date et heure du lancement de la requête.
• lastUpdatedAt : date et heure de la dernière muse à jour de la requête.
• result : résultat de la requête, par exemple le résultat de l’extraction (affiché sous la forme extractionResult).

Échec

Lorsque la demande a échoué, l’appel getResult renvoie un schéma avec les détails suivants :

• status : le statut actuel de la requête. Dans ce cas, le statut est Failed.
• createdAt : date et heure du lancement de la requête.
• lastUpdatedAt : date et heure de la dernière muse à jour de la requête.
• error : la cause des erreurs avec les détails suivants :
  • message : explication détaillée qui décrit l’erreur, par exemple "Internal Server Error. Please contact the UiPath support team."
  • severity : la gravité de l’échec. Dans ce cas, la gravité est le plus souvent Error.
  • code : code spécifique qui identifie le type d’erreur, par exemple [UnexpectedInternalServerError].
  • parameters : contient des informations supplémentaires liées aux erreurs, le cas échéant.