Box · Schema

Client error

A generic error

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
type string error
status integer The HTTP status of the response.
code string A Box-specific error code
message string A short message describing the error.
context_info object A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_url string A URL that links to more information about why this error occurred.
request_id string A unique identifier for this response, which can be used when contacting Box support.
View JSON Schema on GitHub

JSON Schema

box-clienterror-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ClientError",
  "title": "Client error",
  "type": "object",
  "x-box-resource-id": "client_error",
  "description": "A generic error",
  "properties": {
    "type": {
      "description": "error",
      "example": "error",
      "type": "string",
      "enum": [
        "error"
      ],
      "nullable": false
    },
    "status": {
      "description": "The HTTP status of the response.",
      "example": 400,
      "type": "integer",
      "format": "int32",
      "nullable": false
    },
    "code": {
      "description": "A Box-specific error code",
      "example": "item_name_invalid",
      "type": "string",
      "enum": [
        "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"
      ]
    },
    "message": {
      "description": "A short message describing the error.",
      "example": "Method Not Allowed",
      "type": "string",
      "nullable": false
    },
    "context_info": {
      "description": "A free-form object that contains additional context\nabout the error. The possible fields are defined on\na per-endpoint basis. `message` is only one example.",
      "type": "object",
      "nullable": true,
      "properties": {
        "message": {
          "type": "string",
          "description": "More details on the error.",
          "example": "Something went wrong."
        }
      }
    },
    "help_url": {
      "description": "A URL that links to more information about why this error occurred.",
      "example": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
      "type": "string",
      "nullable": false
    },
    "request_id": {
      "description": "A unique identifier for this response, which can be used\nwhen contacting Box support.",
      "type": "string",
      "example": "abcdef123456",
      "nullable": false
    }
  }
}