Shield information barrier reports resources

Shield information barrier reports contain information on what existing collaborations will be removed permanently when the information barrier is enabled.

List of Shield Information Barrier Reports

A list of shield barrier reports.

Attributes and example

Property	Type	Required	Description
`limit`	`integer`	No	The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
`next_marker`	`string`	No	The marker for the start of the next page of results. Can be `null`.
`entries`	array of Shield information barrier report	No	A list of shield information barrier reports.

Example

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "entries": [
    {
      "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"
    }
  ]
}

Shield information barrier reference

A shield information barrier reference for requests and responses.

Attributes and example

Property	Type	Required	Description
`shield_information_barrier`	Shield information barrier (Base)	No

Example

{
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  }
}

Shield information barrier report

A standard representation of a shield information barrier report object.

Attributes and example

Property	Type	Required	Description
`id`	`string`	No	The unique identifier for the shield information barrier report.
`type`	`enum<string>`	No	The type of the shield information barrier report. Available options: `shield_information_barrier_report`.
`shield_information_barrier`	Shield information barrier reference	No
`status`	`enum<string>`	No	Status of the shield information report. Available options: `pending`, `error`, `done`, `cancelled`.
`details`	Shield information barrier report details	No
`created_at`	`string`	No	ISO date time string when this shield information barrier report object was created.
`created_by`	User (Base)	No	The user who created this shield information barrier report.
`updated_at`	`string`	No	ISO date time string when this shield information barrier report was updated.

Example

{
  "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"
}

Shield information barrier report (Base)

A base representation of a shield information barrier report object.

Attributes and example

Property	Type	Required	Description
`id`	`string`	No	The unique identifier for the shield information barrier report.
`type`	`enum<string>`	No	The type of the shield information barrier report. Available options: `shield_information_barrier_report`.

Example

{
  "id": "11446498",
  "type": "shield_information_barrier_report"
}

Shield information barrier report details

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

Attributes and example

Property	Type	Required	Description
`details`	`object`	No

Example

{
  "details": {
    "folder_id": "124235"
  }
}

v2025.0

v2026.0

Shield information barrier reports resources

List of Shield Information Barrier Reports

Shield information barrier reference

Shield information barrier report

Shield information barrier report (Base)

Shield information barrier report details

​List of Shield Information Barrier Reports

​Shield information barrier reference

​Shield information barrier report

​Shield information barrier report (Base)

​Shield information barrier report details

List of Shield Information Barrier Reports

Shield information barrier reference

Shield information barrier report

Shield information barrier report (Base)

Shield information barrier report details