JSON 応答ステータス

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

    JSON 成功応答

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

    __status

    "__status": "<value>"

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

    JSON 失敗応答

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

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

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

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