Latest version
Create shield information barrier segment
API version 2024.0
Creates a shield information barrier segment.
Request
bearer [ACCESS_TOKEN]
application/json
Request Body
stringin bodyoptional
"'Corporate division that engages in
advisory_based financial
transactions on behalf of individuals,
corporations, and governments.'"Description of the shield information barrier segment
stringin bodyrequired
"Investment Banking"Name of the shield information barrier segment
Shield information barrier (Base) objectin body
A base representation of a shield information barrier object
Response
application/jsonShield information barrier segment
Returns a new shield information barrier segment object.
application/jsonClient error
Returns an error if the shield information barrier was not found.
application/jsonClient error
Returns an error if there exists an shield information barrier segment with same name.
application/jsonClient error
An unexpected client error.
Request Example
TypeScript Gen
await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment(
{
shieldInformationBarrier: {
id: barrierId,
type: 'shield_information_barrier' as ShieldInformationBarrierBaseTypeField,
} satisfies ShieldInformationBarrierBase,
name: segmentName,
description: segmentDescription,
} satisfies CreateShieldInformationBarrierSegmentRequestBody,
);Python Gen
client.shield_information_barrier_segments.create_shield_information_barrier_segment(
ShieldInformationBarrierBase(
id=barrier_id,
type=ShieldInformationBarrierBaseTypeField.SHIELD_INFORMATION_BARRIER,
),
segment_name,
description=segment_description,
).NET Gen
await client.ShieldInformationBarrierSegments.CreateShieldInformationBarrierSegmentAsync(requestBody: new CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: new ShieldInformationBarrierBase() { Id = barrierId, Type = ShieldInformationBarrierBaseTypeField.ShieldInformationBarrier }, name: segmentName) { Description = segmentDescription });Swift Gen (Beta)
try await client.shieldInformationBarrierSegments.createShieldInformationBarrierSegment(requestBody: CreateShieldInformationBarrierSegmentRequestBody(shieldInformationBarrier: ShieldInformationBarrierBase(id: barrierId, type: ShieldInformationBarrierBaseTypeField.shieldInformationBarrier), name: segmentName, description: segmentDescription))Java Gen (Beta)
client.getShieldInformationBarrierSegments().createShieldInformationBarrierSegment(new CreateShieldInformationBarrierSegmentRequestBody.CreateShieldInformationBarrierSegmentRequestBodyBuilder(new ShieldInformationBarrierBase.ShieldInformationBarrierBaseBuilder().id(barrierId).type(ShieldInformationBarrierBaseTypeField.SHIELD_INFORMATION_BARRIER).build(), segmentName).description(segmentDescription).build())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"
}
}