Sample - Box Platform API
GET/shield_information_barrier_reports

List shield information barrier reports

Lists shield information barrier reports associated with a specified shield information barrier. Use shield_information_barrier_id to identify the barrier and limit to control the page size. Use marker-based pagination with marker; set usemarker to true when using a marker.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
shield_information_barrier_idstringrequired
The unique identifier of the shield information barrier whose reports to list.
markerstringoptional
The position marker at which to begin returning results for marker-based pagination. Use with `usemarker` set to `true`.
limitintegeroptional
The maximum number of reports to return per page. Must not exceed 1000.

3 status codes
200Returns a paginated list of shield information barrier report objects, including pagination details and report entries.
limitintegeroptional
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_markerstringoptional
The marker for the start of the next page of results.
entriesarray<ShieldInformationBarrierReport>optional
A list of shield information barrier reports.
404Returned when the shield information barrier identified by `shield_information_barrier_id` cannot be found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 404 is returned when the shield information barrier identified by shield_information_barrier_id cannot be found. limit must not exceed 1000, and marker requires usemarker to be set to true when marker-based pagination is used.