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

Shield information barrier segment restriction

A standard representation of a segment restriction of a shield information barrier object

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

id string

example11446498

The unique identifier for the shield information barrier segment restriction.

type string

exampleshield_information_barrier_segment_restriction

Shield information barrier segment restriction

Value is always shield_information_barrier_segment_restriction

created_at string (date-time)

example2020-06-26T18:44:45.869Z

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

created_byUser (Base) object

The user who created this shield information barrier segment Restriction.

restricted_segment object

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

restricted_segment.id string

example1910967

The ID reference of the restricted shield information barrier segment.

restricted_segment.type string

exampleshield_information_barrier_segment

The type of the shield information segment

Value is always shield_information_barrier_segment

shield_information_barrierShield information barrier (Base) object

A base representation of a shield information barrier object

shield_information_barrier_segment object

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

shield_information_barrier_segment.id string

example1910967

The ID reference of the requesting shield information barrier segment.

shield_information_barrier_segment.type string

exampleshield_information_barrier_segment

The type of the shield information barrier segment

Value is always shield_information_barrier_segment

updated_at string (date-time)

example2020-07-26T18:44:45.869Z

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

updated_byUser (Base) object

The user that updated this shield information barrier segment Restriction.

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