Create shield information barrier segment restriction

post

https://api.box.com/2.0

/shield_information_barrier_segment_restrictions

Creates a shield information barrier segment restriction object.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Request Body

type stringin bodyrequired

example"shield_information_barrier_segment_restriction"

The type of the shield barrier segment restriction for this member.

Value is always shield_information_barrier_segment_restriction

restricted_segment objectin body

The type and id of the restricted shield information barrier segment.

restricted_segment.id stringin bodyrequired

example"1910967"

The ID reference of the restricted shield information barrier segment.

restricted_segment.type stringin bodyrequired

example"shield_information_barrier_segment"

The type of the restricted shield information barrier segment.

Value is always shield_information_barrier_segment

shield_information_barrierShield information barrier (Base) objectin body

A base representation of a shield information barrier object

shield_information_barrier_segment objectin body

The type and id of the requested shield information barrier segment.

shield_information_barrier_segment.id stringin bodyrequired

example"1910967"

The ID reference of the requesting shield information barrier segment.

shield_information_barrier_segment.type stringin bodyrequired

example"shield_information_barrier_segment"

The type of the shield barrier segment for this member.

Value is always shield_information_barrier_segment

Response

201application/jsonShield information barrier segment restriction

Returns the newly created Shield Information Barrier Segment Restriction object.

404application/jsonClient error

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

defaultapplication/jsonClient error

An unexpected client error.

post

Create shield information barrier segment restriction

You can now try out some of our APIs live, right here in the documentation.

Request Example

Node

const barrierSegmentRestriction = await client.shieldInformationBarrierSegmentRestrictions.create({
	type: 'shield_information_barrier_segment_restriction',
	shield_information_barrier_segment: {
		type: 'shield_information_barrier_segment',
		id: '1910967'
	},
	restricted_segment: {
		type: 'shield_information_barrier_segment',
		id: '1910968'
	}
});
console.log(`Shield information barrier segment restriction with id ${barrierSegmentRestriction.id} was created`);

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"
  }
}