Latest version
Update shield information barrier segment with specified ID
Updates the shield information barrier segment based on provided ID..
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
3423The ID of the shield information barrier segment.
Request Body
stringin bodyoptional
"'Corporate division that engages in advisory_based
financial transactions on behalf of individuals,
corporations, and governments.'"The updated description for the shield information barrier segment.
stringin bodyoptional
\S+"Investment Banking"The updated name for the shield information barrier segment.
Response
application/jsonShield information barrier segment
Returns the updated shield information barrier segment object.
application/jsonClient error
Returns a not_found error if the shield information
Barrier Segment was not found.
application/jsonClient error
Returns an error if there exists a shield information Barrier Segment with the same name.
application/jsonClient error
An unexpected client error.
Request Example
TypeScript Gen
await client.shieldInformationBarrierSegments.updateShieldInformationBarrierSegmentById(
segmentId,
{
requestBody: {
description: updatedSegmentDescription,
} satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody,
} satisfies UpdateShieldInformationBarrierSegmentByIdOptionalsInput,
);Python Gen
client.shield_information_barrier_segments.update_shield_information_barrier_segment_by_id(
segment_id, description=updated_segment_description
).NET Gen
await client.ShieldInformationBarrierSegments.UpdateShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId, requestBody: new UpdateShieldInformationBarrierSegmentByIdRequestBody() { Description = updatedSegmentDescription });Node
const barrierSegment = await client.shieldInformationBarrierSegments.update({
name: 'updated name',
description: 'updated description',
}, {
shield_information_barrier_segment_id: '12345'
});
console.log(`Shield information barrier segment id ${barrierSegment.id} updated`);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"
}
}