JSON-Antwortstatus

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 1 Minute Lesedauer
  • JSONv2-Anforderungen können einen von mehreren Antwortstatus zurückgeben.

    JSON-Erfolgsantwort

    Jede JSON-Erfolgsantwort enthält ein Datensatz-Array, das die von der angegebenen Aktion abgerufenen Datensätze enthält. Jedes JSON-Objekt enthält mindestens ein Metadatenelement mit dem Präfix __ in Bezug auf den Status der Aktion für jeden Datensatz, wie in den vorherigen Beispielen dargestellt. Die JSON-Erfolgsantworten verwenden die folgende Syntax:

    __Status

    "__status": "<value>"

    Wobei <value> „Erfolg“ oder „Fehler“ ist.

    JSON-Fehlerantwort

    Wenn _Status Element gibt Fehler zurück, die _Fehler Element wird hinzugefügt, um den Fehler und den Grund zu identifizieren.
    "__error": { "message": "<error value>", "reason": "<reason value> "}
    

    Wo <error value> Ist der Fehlermeldungstext und <reason value> Ist der Grund, warum der Fehler ausgelöst wurde.

    Die JSON-Fehlerantwort enthält nur die Fehler- und Ursachenelemente. Im Allgemeinen gibt dies an, dass der gesamte JSON-Vorgang fehlgeschlagen ist und keine Datensätze verarbeitet werden können.

    Zum Beispiel:
    {"_error":"Cannot update with empty sysparm_query","reason":null}