Box Developer Documentation
Log in
Latest version

List shield information barrier reports

get
https://api.box.com/2.0
/shield_information_barrier_reports

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Lists shield information barrier reports.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

stringin queryrequired
1910967

The ID of the shield information barrier.

Response

application/jsonList of Shield Information Barrier Reports

Returns a paginated list of shield information barrier report objects.

application/jsonClient error

Returns a not_found error if the Shield Information Barrier could not be found.

application/jsonClient error

An unexpected client error.

get
List shield information barrier reports
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.shieldInformationBarrierReports.getShieldInformationBarrierReports(
  {
    shieldInformationBarrierId: barrierId,
  } satisfies GetShieldInformationBarrierReportsQueryParams,
);
Python Gen
client.shield_information_barrier_reports.get_shield_information_barrier_reports(
    barrier_id
)
.NET Gen
await client.ShieldInformationBarrierReports.GetShieldInformationBarrierReportsAsync(queryParams: new GetShieldInformationBarrierReportsQueryParams(shieldInformationBarrierId: barrierId));
Swift Gen (Beta)
try await client.shieldInformationBarrierReports.getShieldInformationBarrierReports(queryParams: GetShieldInformationBarrierReportsQueryParams(shieldInformationBarrierId: barrierId))
Java Gen (Beta)
client.getShieldInformationBarrierReports().getShieldInformationBarrierReports(new GetShieldInformationBarrierReportsQueryParams(barrierId))
Node
const result = await client.shieldInformationBarrierReports.getAll({
	shield_information_barrier_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier reports`);

Response Example

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