Box Developer Documentation
Log in
Latest version

Get shield information barrier segment restriction by ID

get
https://api.box.com/2.0
/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_id

Retrieves a shield information barrier segment restriction based on provided ID.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
4563

The ID of the shield information barrier segment Restriction.

Response

application/jsonShield information barrier segment restriction

Returns the shield information barrier segment restriction object.

application/jsonClient error

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

application/jsonClient error

An unexpected client error.

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

Request Example

TypeScript Gen
await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById(
  segmentRestrictionId,
);
Python Gen
client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restriction_by_id(
    segment_restriction_id
)
.NET Gen
await client.ShieldInformationBarrierSegmentRestrictions.GetShieldInformationBarrierSegmentRestrictionByIdAsync(shieldInformationBarrierSegmentRestrictionId: segmentRestrictionId);
Swift Gen (Beta)
try await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionById(shieldInformationBarrierSegmentRestrictionId: segmentRestrictionId)
Node
const barrierSegmentRestriction = await client.shieldInformationBarrierSegmentRestrictions.getById({
	shield_information_barrier_segment_restriction_id: '12345',
});
console.log(`Shield information barrier segment restriction id ${barrierSegmentRestriction.id}`);

Response Example

{
  "id": "11446498",
  "type": "shield_information_barrier_segment_restriction",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "restricted_segment": {
    "id": "1910967",
    "type": "shield_information_barrier_segment"
  },
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "shield_information_barrier_segment": {
    "id": "1910967",
    "type": "shield_information_barrier_segment"
  },
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}