État de la réponse JSON

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture

    • Les demandes JSONv2 peuvent renvoyer l’un des états de réponse.

    Réponse de réussite JSON

    Chaque réponse de réussite JSON inclut un tableau d’enregistrements contenant les enregistrements récupérés par l’action donnée. Chaque objet JSON contient un ou plusieurs éléments de métadonnées, précédés du préfixe __, concernant l’état de l’action sur chaque enregistrement, comme illustré dans les exemples précédents. Les réponses de réussite JSON utilisent la syntaxe suivante :

    __statut

    "__status": "<value>"

    où <valeur> est le succès ou l’échec.

    Réponse d’échec JSON

    Lorsque l’élément _status renvoie une défaillance, l’élément _error est ajouté pour identifier l’erreur et la raison.
    "__error": { "message": "<error value>", "reason": "<reason value> "}

    où <valeur d’erreur> correspond au texte du message d’erreur et <valeur de motif> correspond à la raison pour laquelle l’erreur a été déclenchée.

    La réponse à l’erreur JSON contient uniquement les éléments error et reason. Généralement, cela indique que toute l’opération JSON a échoué et qu’aucun enregistrement ne peut être traité.

    Par exemple :
    {"_error":"Cannot update with empty sysparm_query","reason":null}