Box Developer Documentation
Log in
Latest version

Get shield information barrier segment with specified ID

get
https://api.box.com/2.0
/shield_information_barrier_segments/:shield_information_barrier_segment_id

Retrieves shield information barrier segment based on provided ID..

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
3423

The ID of the shield information barrier segment.

Response

application/jsonShield information barrier segment

Returns the shield information barrier segment object.

application/jsonClient error

Returns a not_found error if the shield information barrier segment was not found.

application/jsonClient error

An unexpected client error.

get
Get shield information barrier segment with specified ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById(
  segmentId,
);
Python Gen
client.shield_information_barrier_segments.get_shield_information_barrier_segment_by_id(
    segment_id
)
.NET Gen
await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId);
Node
const barrierSegment = await client.shieldInformationBarrierSegments.getById({
	shield_information_barrier_segment_id: '12345',
});
console.log(`Shield information barrier segment id ${barrierSegment.id}`);

Response Example

{
  "id": "11446498",
  "type": "shield_information_barrier_segment",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
  "name": "Investment Banking",
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}