Sample - Box Platform API
GET/shield_information_barriers/{shield_information_barrier_id}

Get shield information barrier with specified ID

Get shield information barrier based on provided ID.

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

1 parameter
shield_information_barrier_idstringrequired
The ID of the shield information barrier.

3 status codes
200Returns the shield information barrier object.
idstringoptional
The unique identifier for the shield information barrier.
typestringoptional
The type of the shield information barrier.
Allowed:shield_information_barrier
enterpriseobjectoptional
The `type` and `id` of enterprise this barrier is under.
statusstringoptional
Status of the shield information barrier.
Allowed:draftpendingdisabledenabledinvalid
created_atstringoptional
ISO date time string when this shield information barrier object was created.
created_byobjectoptional
The user who created this shield information barrier.
updated_atstringoptional
ISO date time string when this shield information barrier was updated.
updated_byobjectoptional
The user that updated this shield information barrier.
enabled_atstringoptional
ISO date time string when this shield information barrier was enabled.
enabled_byobjectoptional
404Returns a `not_found` error if the shield information barrier 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 was not found. Any other status is an error: An unexpected client error.