Box Developer Documentation
Log in
Latest version

List shield information barrier segment restrictions

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

Lists shield information barrier segment restrictions based on provided segment ID.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

stringin queryrequired
3423

The ID of the shield information barrier segment.

Response

application/jsonList of Shield Information Barrier Segment Restrictions

Returns a paginated list of shield information barrier segment restriction objects.

application/jsonClient error

An unexpected client error.

get
List shield information barrier segment restrictions
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions(
  {
    shieldInformationBarrierSegmentId: segmentId,
  } satisfies GetShieldInformationBarrierSegmentRestrictionsQueryParams,
);
Python Gen
client.shield_information_barrier_segment_restrictions.get_shield_information_barrier_segment_restrictions(
    segment_id
)
.NET Gen
await client.ShieldInformationBarrierSegmentRestrictions.GetShieldInformationBarrierSegmentRestrictionsAsync(queryParams: new GetShieldInformationBarrierSegmentRestrictionsQueryParams(shieldInformationBarrierSegmentId: segmentId));
Node
const result = await client.shieldInformationBarrierSegmentRestrictions.getAll({
	shield_information_barrier_segment_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segment restrictions`);

Response Example

{
  "entries": [
    {
      "type": "shield_information_barrier_segment_restriction",
      "id": "11446498",
      "shield_information_barrier_segment": {
        "id": "1910967",
        "type": "shield_information_barrier_segment"
      },
      "restricted_segment": {
        "id": "1910967",
        "type": "shield_information_barrier_segment"
      },
      "shield_information_barrier": {
        "id": "11446498",
        "type": "shield_information_barrier"
      },
      "created_at": "2020-06-26T18:44:45.869Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "updated_at": "2020-07-26T18:44:45.869Z",
      "updated_by": {
        "id": "11446498",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}