Sample - Box Platform API
GET/shield_information_barrier_reports/{shield_information_barrier_report_id}

Get shield information barrier report by ID

Retrieves a shield information barrier report by its ID.

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

1 parameter
shield_information_barrier_report_idstringrequired
The ID of the shield information barrier Report.

3 status codes
200Returns the shield information barrier report object.
idstringoptional
The unique identifier for the shield information barrier report.
typestringoptional
The type of the shield information barrier report.
Allowed:shield_information_barrier_report
shield_information_barrierobjectoptional
statusstringoptional
Status of the shield information report.
Allowed:pendingerrordonecancelled
detailsobjectoptional
created_atstringoptional
ISO date time string when this shield information barrier report object was created.
created_byobjectoptional
updated_atstringoptional
ISO date time string when this shield information barrier report was updated.
404Returns a `not_found` error if the shield information barrier Report was not 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.
defaultAn unexpected client error.
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: Returns a not_found error if the shield information barrier Report was not found. Any other status is an error: An unexpected client error.