Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Shield information barrier segments

Update shield information barrier segment with specified ID

Updates the shield information barrier segment based on provided ID..

put/shield_information_barrier_segments/{shield_information_barrier_segment_id}

Path parameters

shield_information_barrier_segment_idstring required

The ID of the shield information barrier segment.

Request body

namestring

The updated name for the shield information barrier segment.

descriptionstring nullable

The updated description for the shield information barrier segment.

Example request

{
  "name": "Investment Banking",
  "description": "'Corporate division that engages in advisory_based\nfinancial transactions on behalf of individuals,\ncorporations, and governments.'"
}

Response

Returns the updated shield information barrier segment object.

idstring

The unique identifier for the shield information barrier segment.

type'shield_information_barrier_segment'

The type of the shield information barrier segment.

namestring

Name of the shield information barrier segment.

descriptionstring

Description of the shield information barrier segment.

created_atstring date-time

ISO date time string when this shield information barrier object was created.

updated_atstring date-time

ISO date time string when this shield information barrier segment was updated.

Example response

{
  "id": "11446498",
  "type": "shield_information_barrier_segment",
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "name": "Investment Banking",
  "description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
  "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"
  }
}