JSON 応答ステータス

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:1分
  • JSONv2 要求は、いくつかの応答ステータスのいずれかを返す場合があります。

    JSON 成功応答

    JSON の各成功応答には、指定されたアクションによって取得されたレコードを含むレコードアレイが含まれています。前の例で示したように、各 JSON オブジェクトには、各レコードのアクションのステータスに関するメタデータ要素が 1 つ以上含まれ、プリフィックス __ が付けられています。JSON の成功応答では、次の構文を使用します。

    __status

    "__status": "<value>"

    <value> は成功または失敗です。

    JSON 失敗応答

    _status 要素が失敗を返すと、エラーと理由を特定するために _error 要素が追加されます。
    "__error": { "message": "<error value>", "reason": "<reason value> "}
    

    <error value> はエラーメッセージテキストであり、<reason value> は、エラーがトリガーされた理由です。

    JSON エラー応答には、エラー要素と理由要素のみが含まれています。通常、これは JSON 操作全体が失敗し、レコードを処理できないことを示します。

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