Join BoxWorks 2024 to discover what's possible with content and AI!

Create shield information barrier segment

post

https://api.box.com/2.0

/shield_information_barrier_segments

Creates a shield information barrier segment.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Request Body

description stringin bodyoptional

example

"'Corporate division that engages in
 advisory_based financial
transactions on behalf of individuals,
corporations, and governments.'"

Description of the shield information barrier segment

name stringin bodyrequired

example"Investment Banking"

Name of the shield information barrier segment

shield_information_barrierShield information barrier (Base) objectin body

A base representation of a shield information barrier object

Response

201application/jsonShield information barrier segment

Returns a new shield information barrier segment object.

404application/jsonClient error

Returns an error if the shield information barrier was not found.

409application/jsonClient error

Returns an error if there exists an shield information barrier segment with same name.

defaultapplication/jsonClient error

An unexpected client error.

post

Create shield information barrier segment

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

Request Example

TypeScript Gen

await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment(
  {
    shieldInformationBarrier: {
      id: barrierId,
      type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField,
    } satisfies ShieldInformationBarrierBase,
    name: segmentName,
  } satisfies CreateShieldInformationBarrierSegmentRequestBody,
);

Python Gen

client.shield_information_barrier_segments.create_shield_information_barrier_segment(
    ShieldInformationBarrierBase(
        id=barrier_id,
        type=ShieldInformationBarrierBaseTypeField.SHIELD_INFORMATION_BARRIER.value,
    ),
    segment_name,
)

.NET Gen

await client.ShieldInformationBarrierSegments.CreateShieldInformationBarrierSegmentAsync(requestBody: new CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: new ShieldInformationBarrierBase() { Id = barrierId, Type = ShieldInformationBarrierBaseTypeField.ShieldInformationBarrier }, name: segmentName));

Swift Gen (Beta)

try await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment(requestBody: CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: ShieldInformationBarrierBase(id: barrierId, type: ShieldInformationBarrierBaseTypeField.shieldInformationBarrier), name: segmentName))

Node

const barrierSegment = await client.shieldInformationBarrierSegments.create({
	name: 'barrier segment name',
	description: 'barrier segment description',
	shield_information_barrier: {
		id: '123',
		type: 'shield_information_barrier'
	},
});
console.log(`Shield information barrier segment id ${barrierSegment.id} created`);

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