エラー

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

クライアントエラー

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

{
  "type": "error",
  "status": 400,
  "code": "bad_digest",
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "message": "The specified content-md5 did not match what we received",
  "request_id": "abcdef123456"
}

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

共通エラーコード

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

400 Bad Request

| Solution | Verify that the file's name is valid. Box only supports file or folder names that are 255 characters or less. File names containing non-printable characters, names containing the characters /, \, <, >, :, |, ?, *, — , names with leading or trailing spaces, and the special names “.” and “..” are also unsupported. | | | | | Error | item_name_too_long | | Message | Item name too long | | Solution | Shorten the length of the name that is being supplied for the item. The maximum length of a file or folder name in Box is 255 characters or less. | | | | | Error | metadata_after_file_contents | | Message | Metadata is included after file contents in a file upload request. | | Solution | Include the file metadata before the file's contents. | | Error | password_reset_required | | Message | User needs to reset password | | Solution | The user has not yet completed account setup steps. | | | | | Error | requested_page_out_of_range | | Message | Requested representation page out of range | | Solution | The range header supplied does not fit within the size of the specified item. Adjust the bounds to fit within the size of the item and try again. | | | | | Error | requested_preview_unavailable | | Message | Requested preview unavailable| | Solution | The thumbnail size requested for the file is not valid. See the reference docs for the API operation for available format sizes. | | | | | Error | sync_item_move_failure | | Message | Cannot move a synced item | | Solution | The item is set to be synced by the Box sync clients and cannot be moved. A possible solution is to set the sync_state of the item to not_synced. | | | | | Error | task_assignee_not_allowed | | Message | Assigner does not have sufficient privileges to assign task to assignee | | Solution | The user who is attempting to assign the task does not have the appropriate permissions to do so. Adjust the user permissions to allow the assignment of tasks. | | | | | Error | terms_of_service_required | | Message | User must accept custom terms of service before action can be taken | | Solution | The admin of your Box account has set custom terms of service and the user has not logged in to accept the terms yet. The user will need to accept the terms of service, or the admin will have to disable them, in order to proceed. More information is available here. | | | | | Error| user_already_collaborator | | Message | User is already a collaborator | | Solution | The user that you are attempting to collaborate in on an item is already collaborated on that item. This request is not needed.| | | |

401 Unauthorized

403 Forbidden

404 Not Found

405 Method Not Allowed

409 Conflict

410 Gone

411 Length Required

412 Precondition Failed

413 Request Entity Too Large

415 Unsupported Media Type

429 Too Many requests

500 Internal Service Error

502 Bad Gateway

503 Unavailable