クライアントエラー

一般的なエラー

type string

例error

error

次の値に固定: error

code string

例item_name_invalid

Box固有のエラーコード

次の値のいずれか1つ: created,accepted,no_content,redirect,not_modified,bad_request,unauthorized,forbidden,not_found,method_not_allowed,conflict,precondition_failed,too_many_requests,internal_server_error,unavailable,item_name_invalid,insufficient_scope

context_info object

このエラーに関する追加コンテキストを含む自由形式のオブジェクト。使用できるフィールドは、エンドポイントごとに定義されています。messageは唯一の例です。

context_info.message string

例Something went wrong.

エラーの詳細。

help_url string

例https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/

このエラーの原因に関する詳細情報にリンクされたURL。

message string

例Method Not Allowed

エラーについての短い説明メッセージ。

request_id string

例abcdef123456

Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。

status integer / int32

例400

レスポンスのHTTPステータス。

レスポンスの例

{
  "type": "error",
  "code": "item_name_invalid",
  "context_info": {
    "message": "Something went wrong."
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "message": "Method Not Allowed",
  "request_id": "abcdef123456",
  "status": 400
}