A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.
Latest version
List shield information barrier reports
API version 2024.0
Lists shield information barrier reports.
Request
bearer [ACCESS_TOKEN]
application/json
Query Parameters
integer (int64)in queryoptional
10001000The maximum number of items to return per page.
stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiDefines 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
1910967The 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.
Request Example
Node/TypeScript v10
await client.shieldInformationBarrierReports.getShieldInformationBarrierReports(
{
shieldInformationBarrierId: barrierId,
} satisfies GetShieldInformationBarrierReportsQueryParams,
);Python v10
client.shield_information_barrier_reports.get_shield_information_barrier_reports(
barrier_id
).NET v10
await client.ShieldInformationBarrierReports.GetShieldInformationBarrierReportsAsync(queryParams: new GetShieldInformationBarrierReportsQueryParams(shieldInformationBarrierId: barrierId));Swift v10
try await client.shieldInformationBarrierReports.getShieldInformationBarrierReports(queryParams: GetShieldInformationBarrierReportsQueryParams(shieldInformationBarrierId: barrierId))Java v10
client.getShieldInformationBarrierReports().getShieldInformationBarrierReports(new GetShieldInformationBarrierReportsQueryParams(barrierId))Node v4
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"
}