Skip to main content
POST
/
shield_information_barrier_reports
cURL
curl --request POST \
  --url https://api.box.com/2.0/shield_information_barrier_reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  }
}
'
{
  "id": "11446498",
  "type": "shield_information_barrier_report",
  "shield_information_barrier": {
    "shield_information_barrier": {
      "id": "11446498",
      "type": "shield_information_barrier"
    }
  },
  "status": "pending",
  "details": {
    "details": {
      "folder_id": "124235"
    }
  },
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "updated_at": "2020-07-26T18:44:45.869Z"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

A shield information barrier reference for requests and responses.

​
shield_information_barrier
Shield information barrier (Base) · object

A base representation of a shield information barrier object.

Response

Returns the shield information barrier report information object.

A standard representation of a shield information barrier report object.

​
id
string

The unique identifier for the shield information barrier report.

Example:

"11446498"

​
type
enum<string>

The type of the shield information barrier report.

Available options:
shield_information_barrier_report
Example:

"shield_information_barrier_report"

​
shield_information_barrier
Shield information barrier reference · object

A shield information barrier reference for requests and responses.

​
status
enum<string>

Status of the shield information report.

Available options:
pending,
error,
done,
cancelled
Example:

"pending"

​
details
Shield information barrier report details · object

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

​
created_at
string<date-time>

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

Example:

"2020-06-26T18:44:45.869Z"

​
created_by
User (Base) · object

The user who created this shield information barrier report.

​
updated_at
string<date-time>

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

Example:

"2020-07-26T18:44:45.869Z"