Skip to main content
API version 2024.0 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.
​
id
string
example: 11446498The unique identifier for the shield information barrier report.
​
type
string
example: shield_information_barrier_reportThe type of the shield information barrier report.Value is always shield_information_barrier_report
​
created_at
string(date-time)
example: 2020-06-26T18:44:45.869ZISO date time string when this shield information barrier report object was created.
​
created_by
User (Base)object
The user who created this shield information barrier report.
​
details
Shield information barrier report detailsobject
Indicates which folder the report file is located and any errors when generating the report.
​
shield_information_barrier
Shield information barrier referenceobject
A shield information barrier reference for requests and responses.
​
status
string
example: pendingStatus of the shield information report.Value is one of pending,error,done,cancelled
​
updated_at
string(date-time)
example: 2020-07-26T18:44:45.869ZISO date time string when this shield information barrier report was updated.
{
  "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"
}