一般的なエラー

一般的なエラー

Box APIでは、HTTPステータスコードを使用して、リクエストが正常に処理されたかどうかを通知します。

クライアントエラー

HTTP 4XX形式の大半のクライアントエラーとHTTP 5XX形式の一部のサーバーエラーでは、標準のクライアントエラーJSONオブジェクトが返されます。

{
  "type": "error",
  "status": 400,
  "code": "bad_digest",
  "help_url": "http://developers.box.com/docs/#errors",
  "message": "The specified content-md5 did not match what we received",
  "request_id": "abcdef123456"
}

詳細については、クライアントエラーのリソースを参照してください。

共通エラーコード

Box APIの使用時に発生した一般的なエラーの解決策については、開発者向けトラブルシューティングの記事を確認してください。

400 Bad Request

エラーbad_digest
メッセージThe specified content-md5 did not match what we received (指定のcontent-md5は受信したものと一致しませんでした)
解決策ファイルのアップロード中に、ファイルのSHA-1ハッシュとcontent-md5ヘッダーを指定して、ファイルが転送中に破損していないかどうかを確認できます。リクエストで指定されたSHA-1ハッシュは、アップロードで受信したものと一致していません。アップロードしたファイルの有効なSHA-1ハッシュを指定してください。
エラーbad_request
メッセージ
解決策APIリクエストで指定された必須パラメータが見つからないか無効です。詳細については、応答本文の拡張エラーメッセージを確認してください。
エラーcannot_make_collaborated_subfolder_private
メッセージCannot move a collaborated folder to a private folder unless the new owner is explicitly specified (新しい所有者が明示的に指定されない限り、コラボレーションフォルダを非公開フォルダに移動することはできません)
解決策リクエストのowned_by.idフィールドを設定して、コンテンツの転送先となるユーザーのIDを指定してください。
エラーcollaborations_not_available_on_root_folder
メッセージRoot folder cannot be collaborated (ルートフォルダのコラボレーションができません)
解決策ユーザーのルートフォルダ(フォルダID 0)にコラボレータを設定できません。ルートフォルダとは異なるフォルダIDを使用してください。
エラーcyclical_folder_structure
メッセージFolder move creates cyclical folder structure (フォルダの移動により循環フォルダ構造が作成されます)
解決策フォルダの移動で指定したフォルダIDによって、循環フォルダ構造(たとえば、フォルダがそのフォルダ内のサブフォルダに移動される構造)が作成されます。フォルダ移動リクエストで指定するフォルダを変更してください。
エラーfolder_not_empty
メッセージCannot delete – folder not empty (削除できません – フォルダにファイルが存在しません)
解決策削除する前に、フォルダからすべてのコンテンツを削除してください。
エラーinvalid_collaboration_item
メッセージItem type must be specified and set to 'folder' (項目タイプは指定されていなければならず、「folder」に設定されていることが必要です)
解決策コラボレーション項目のitem.typeフィールドをフォルダに設定してください。
エラーinvalid_grant
メッセージVerify the authorization code is set correctly in your request, or your application likely needs to get a new authorization code. (リクエストに承認コードが正しく設定されていることを確認してください。そうしないと、アプリケーションで新しい承認コードが必要になる可能性があります。)
解決策APIリクエストで指定された承認コードが見つからないか、無効になりました。考えられる解決策として、リクエストにアクセストークンが正しく追加されているかどうかを確認してください。正しく設定されている場合は、アクセストークンが期限切れになっている可能性があります。アクセストークンを更新するか、新しいアクセストークンを取得してください。
エラーinvalid_grant
メッセージCurrent date time must be before the expiration date time listed in the 'exp' claim. (現在の日時は'exp'クレームに記載されている有効期限の日時よりも前である必要があります。)
解決策このエラーは、ローカルマシンとBoxサーバーのUnix時間が同期されていない場合に発生します。このエラーを修正するには、ローカルマシンのUnix時間を、同期対象の時刻サーバーと一致するよう更新し、再度リクエストしてみてください。
エラーinvalid_limit
メッセージLimit is not a valid number (制限値が有効な数値ではありません)
解決策指定された制限値に有効な数値を追加してください。
エラーinvalid_offset
メッセージOffset is not a valid number (オフセットが有効な数値ではありません)
解決策指定されたオフセット値に有効な数値を追加してください。
エラーinvalid_request_parameters
メッセージInvalid input parameters in request (リクエスト内に無効な入力パラメータがあります)
解決策APIリクエストで無効なパラメータが送信されました。APIリファレンスドキュメントで、このAPI操作に指定すべき正しいリクエストパラメータを確認してください。
エラーinvalid_status
メッセージYou can change the status only if the collaboration is pending (ステータスを変更できるのは、コラボレーションが保留中の場合のみです)
解決策コラボレーションのステータスは、現在のステータスが保留中に設定されている場合に、accessible_byフィールドで指定されたユーザーのみが承認済みまたは拒否済みに更新できます。
エラーinvalid_upload_session_id
メッセージThe upload session ID provided in the URL is not of a valid format. (URLに指定されているアップロードセッションIDが有効な形式ではありません。)
解決策分割アップロードAPIリクエストの送信時に指定されたセッションIDが無効です。作成されたセッションと同じセッションIDを使用してください。
エラーitem_name_invalid
メッセージItem name invalid (項目名が無効です)
解決策ファイルの名前が有効であることを確認してください。Boxでは、255文字以下のファイル名またはフォルダ名のみがサポートされています。印刷不可能なASCII文字、"/"または""を含む名前、先頭または末尾にスペースを含む名前のほか、“.”および“..”という予約済みの名前も使用できません。
エラーitem_name_too_long
メッセージItem name too long (項目名が長すぎます)
解決策項目に指定されている名前の長さを短くしてください。Boxのファイル名またはフォルダ名に使用できる文字数は255文字以下です。
エラーmetadata_after_file_contents
メッセージMetadata is included after file contents in a file upload request. (メタデータは、ファイルアップロードリクエストでファイルのコンテンツの後に含まれています。)
解決策ファイルのコンテンツの前にファイルのメタデータを含めてください。
エラーpassword_reset_required
メッセージUser needs to reset password (ユーザーはパスワードをリセットする必要があります)
解決策ユーザーは、アカウントの設定手順を完了していません。
エラーrequested_page_out_of_range
メッセージRequested representation page out of range (リクエストされたレプリゼンテーションページが範囲外です)
解決策指定された範囲ヘッダーは、指定した項目のサイズに収まりません。項目のサイズに収まるよう範囲を調整し、もう一度やり直してください。
エラーrequested_preview_unavailable
メッセージRequested preview unavailable (リクエストされたプレビューは利用できません)
解決策ファイルに対してリクエストされたサムネイルサイズが有効ではありません。API操作のリファレンスドキュメントで、利用可能な形式サイズを確認してください。
エラーsync_item_move_failure
メッセージCannot move a synced item (同期した項目を移動できません)
解決策項目は、Box Syncクライアントによって同期が設定されているため移動できません。項目のsync_statenot_syncedに設定することで、解決できる場合があります。
エラーtask_assignee_not_allowed
メッセージAssigner does not have sufficient privileges to assign task to assignee (任命者には、担当者にタスクを割り当てるのに十分な権限がありません)
解決策タスクを割り当てようとしているユーザーに、そのための適切な権限がありません。タスクの割り当てを許可するようユーザー権限を調整してください。
エラーterms_of_service_required
メッセージUser must accept custom terms of service before action can be taken (ユーザーは操作を実行する前にカスタムの利用規約に同意する必要があります)
解決策Boxアカウントの管理者はカスタムの利用規約を設定していますが、ユーザーはまだログインしてこの利用規約に同意していません。続行するには、ユーザーがこの利用規約に同意するか、管理者が同規約を無効にする必要があります。詳細については、こちらで確認してください。
エラーuser_already_collaborator
メッセージユーザーはすでにコラボレータです
解決策ある項目のコラボレータに設定しようとしているユーザーは、すでにその項目のコラボレータです。このリクエストは必要ありません。

401 Unauthorized

エラーunauthorized
メッセージ許可なし
解決策承認トークンは承認されていません。詳細については、本文の拡張エラーメッセージを確認してください。

403 Forbidden

エラーaccess_denied_insufficient_permissions
メッセージAccess denied – insufficient permission (アクセスが拒否されました – 権限が不足しています)
通常、このエラーは、API操作に必要なスコープが有効になっていない場合に発生します。解決策の情報については、こちらを参照してください。
エラーaccess_denied_item_locked
メッセージAccess denied – item locked (アクセスが拒否されました – 項目がロックされています)
解決策ロックされた項目にアクセスしようとしていますが、アクセスするための適切な権限がありません。項目のロックを解除してから、再度アクセスしてみてください。
エラーaccess_from_location_blocked
メッセージ
解決策管理者によって承認されていない場所からBoxにログインしようとしています。この問題を解決するには、管理者に連絡してください。
エラーfile_size_limit_exceeded
メッセージファイルサイズがフォルダ所有者のファイルサイズ上限を超えています
解決策アカウントの種類に基づいたファイルサイズの上限については、こちらを参照してください。
エラーforbidden
メッセージ
解決策クライアントには、このセッションにアップロードするための権限がありません。アップロードできるのは、アップロードセッションを開始したユーザーのみです。
エラーforbidden_by_policy
メッセージAccess denied – Blocked by Shield Access Policy (アクセスが拒否されました – Shieldアクセスポリシーによってブロックされています)
解決策会社に適用されているShieldアクセスポリシーによってこの操作が妨げられています。エンタープライズ管理者に連絡して、適用されているShieldアクセスポリシーを調整してください。
エラーforbidden_by_policy
メッセージAccess denied – Blocked by Shield Malware Detection Rule (アクセスが拒否されました – Shieldマルウェア検出ルールによってブロックされています)
解決策Shieldマルウェア検出ルールを有効化すると、悪意のある可能性のあるコンテンツをダウンロードしたり、ローカルで編集したりできなくなりますが、引き続きプレビューとオンライン編集は可能です。適用されているShieldポリシーを調整するには、会社の管理者にお問い合わせください。
エラーincorrect_shared_item_password
メッセージ
解決策共有項目にはパスワードが必要ですが、パスワードが誤っているか指定されていません。
エラーstorage_limit_exceeded
メッセージアカウントのストレージサイズの上限に達しました
解決策アカウントのストレージサイズの上限に達しました。続行するには、アカウントをアップグレードするか、コンテンツを完全に削除してください。単にごみ箱に移動したコンテンツも、完全に削除されるまでアカウントの合計サイズにカウントされます。
エラーuser_email_confirmation_required
メッセージUser needs to complete email confirmation (ユーザーはメール確認を完了する必要があります)
解決策ユーザーは、メール確認の手順をまだ完了していません。

404 Not Found

エラーnot_found
メッセージ
解決策リソースが見つかりませんでした。詳細については、応答本文の拡張エラーメッセージを確認してください。
エラーnot_trashed
メッセージItem is not trashed (項目はごみ箱に移動されていません)
解決策ごみ箱には、完全に削除する項目がありません。最初に、項目をごみ箱に移動してください。
エラーpreview_cannot_be_generated
メッセージPreview cannot be generated (プレビューを生成できません)
解決策指定されたファイルのプレビューのサムネイルを生成できません。
エラーtrashed
メッセージItem is trashed (項目はごみ箱に移動されました)
解決策アクセス対象の項目がごみ箱にあり、変更できません。項目をごみ箱から移動してやり直してください。

405 Method Not Allowed

エラーmethod_not_allowed
メッセージMethod Not Allowed (メソッドが許可されていません)
解決策API操作に使用されるHTTPメソッドは許可されていません。APIリファレンスドキュメントで、API操作に必要なHTTP動詞を確認してください。

409 Conflict

エラーconflict
メッセージA resource with this value already exists (この値のリソースはすでに存在します)
解決策このエラーは、作成するリソースがすでに存在する場合に発生する可能性があります。詳細については、応答本文の拡張エラーメッセージを確認してください。
エラーitem_name_in_use
メッセージItem with the same name already exists (同じ名前の項目はすでに存在します)
解決策このエラーは、同じ名前のリソースがすでに存在している場合に発生する可能性があります。追加/変更するリソース名には一意の名前を指定してください。
エラーname_temporarily_reserved
メッセージThe item name is reserved by another processing item. Wait and then retry the request, or wait and check the parent folder to see if the name is in use. (項目名は別の処理項目によって予約されています。しばらく待ってからリクエストを再試行するか、しばらく待ってから名前が使用中であるかどうか親フォルダを確認してください。)
解決策重複する2つのリクエストが同時に送信されました。Boxは最初のリクエストを確認して名前を予約しますが、最初のリクエストの処理が完了する前に2つ目の重複するリクエストを受信しています。最初のリクエストが完了してから2番目のリクエストを送信してください。
エラーoperation_blocked_temporary
メッセージThe operation is blocked by another ongoing operation (他の進行中の操作によって操作がブロックされました)
解決策このエラーは、移動やコピーなど、他のフォルダ操作によってブロックされたフォルダにアクセスしようとしたときに返されます。後でもう一度やり直してください。
エラーrecent_similar_comment
メッセージA similar comment has been made recently (同様のコメントが最近作成されました)
解決策同様のコメントが最近作成されており、重複する可能性があるためAPIがフラグを設定しています。コメントが実際に作成済みか確認するか、コメントの内容を変更してやり直してください。
エラーuser_login_already_used
メッセージUser with the specified login already exists (指定のログインを持つユーザーがすでに存在します)
解決策同じメールのユーザーがすでに存在します。既存ユーザーを参照するか、別のメールアドレスを指定してください。

410 Gone

エラーsession_expired
メッセージ
解決策指定されたアップロードセッションIDに関連付けられたアップロードセッションは、有効期限が切れているためアクセスできません。
エラーupload_failed
メッセージ
解決策アップロードセッションで回復不能なエラー状態になり、続行できません。このリクエストまたはその他のリクエストのアップロードセッションは、結果として、不適切な状態(パーツ重複など)になりました。この状態の原因として、パーツの上限を超過しているか、重複するパーツがアップロード済みであることが考えられます。

411 Length Required

エラーlength_required
メッセージcontent-length header was required, but not provided. (content-lengthヘッダーが要求されましたが、指定されていません。)
解決策APIリクエストでContent-Lengthヘッダーを指定してください。

412 Precondition Failed

エラーprecondition_failed
メッセージThe resource has been modified. Please retrieve the resource again and retry (このリソースは変更されています。リソースをもう一度取得してから再試行してください)
解決策詳細については、応答本文の拡張エラーメッセージを確認してください。
エラーsync_state_precondition_failed
メッセージThe resource has been modified. Please retrieve the resource again and retry (このリソースは変更されています。リソースをもう一度取得してから再試行してください)
解決策詳細については、応答本文の拡張エラーメッセージを確認してください。

413 Request Entity Too Large

エラーrequest_entity_too_large
メッセージRequest Entity too Large (リクエストのエンティティが大きすぎます)
解決策アップロードのサイズが許容された上限を超えると、このエラーが発生します。応答本文の拡張エラーメッセージを確認してください。

415 Unsupported Media Type

エラーunsupported_media_type
メッセージPreviews for boxnote files are not yet supported. (boxnoteファイルのプレビューはサポートされていません。)
解決策このエラーは、Box Noteの埋め込みプレビューをリクエストしたときに発生します。現時点では、埋め込みプレビューがBox Notesでサポートされていません。

429 Too Many requests

エラーrate_limit_exceeded
メッセージRequest rate limit exceeded, please try again later (リクエストのレート制限を超えました。後でもう一度やり直してください)
解決策クライアントの処理が速すぎて、レート制限を受けました。クライアントでは、retry-afterヘッダーで指定された時間が経過してからリクエストをやり直すことが推奨されます。4つのレート制限に注意する必要があります。

500 Internal Service Error

エラーinternal_server_error
メッセージInternal Server Error (内部サーバーエラー)
解決策クライアントは指数バックオフ戦略を使用してやり直す必要があります

502 Bad Gateway

エラーbad_gateway
メッセージ
解決策クライアントは指数バックオフ戦略を使用してやり直す必要があります

503 Unavailable

エラーunavailable
メッセージ利用できません
解決策詳細については、BoxのAPIステータスのページを確認してください。