Box Developer Documentation
Log in

Shield information barrier report

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

A standard representation of a shield information barrier report object

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
11446498

The unique identifier for the shield information barrier report

string
shield_information_barrier_report

The type of the shield information barrier report

Value is always shield_information_barrier_report

string (date-time)
2020-06-26T18:44:45.869Z

ISO date time string when this shield information barrier report object was created.

User (Base) object

The user who created this shield information barrier report.

Shield information barrier report details object

Indicates which folder the report file is located and any errors when generating the report.

Shield information barrier reference object

A shield information barrier reference for requests and responses

string
pending

Status of the shield information report

Value is one of pending,error,done,cancelled

string (date-time)
2020-07-26T18:44:45.869Z

ISO date time string when this shield information barrier report was updated.

Response Example

{
  "id": "11446498",
  "type": "shield_information_barrier_report",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "details": {
    "details": {
      "folder_id": "124235"
    }
  },
  "shield_information_barrier": {
    "shield_information_barrier": {
      "id": "11446498",
      "type": "shield_information_barrier"
    }
  },
  "status": "pending",
  "updated_at": "2020-07-26T18:44:45.869Z"
}