Box · Schema

Shield information barrier segment restriction (Mini)

A mini representation of a segment restriction object for the shield information barrier

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-shieldinformationbarriersegmentrestriction-mini-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShieldInformationBarrierSegmentRestriction--Mini",
  "title": "Shield information barrier segment restriction (Mini)",
  "type": "object",
  "x-box-resource-id": "shield_information_barrier_segment_restriction--mini",
  "x-box-tag": "shield_information_barrier_segment_restrictions",
  "x-box-variants": [
    "base",
    "mini",
    "standard"
  ],
  "x-box-variant": "mini",
  "description": "A mini representation of\na segment restriction object for\nthe shield information barrier",
  "required": [
    "shield_information_barrier_segment",
    "restricted_segment"
  ],
  "allOf": [
    {
      "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction--Base"
    },
    {
      "properties": {
        "shield_information_barrier_segment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "example": "1910967",
              "description": "The ID reference of the\nrequesting shield information barrier segment."
            },
            "type": {
              "type": "string",
              "description": "The type of the shield information barrier segment",
              "example": "shield_information_barrier_segment",
              "enum": [
                "shield_information_barrier_segment"
              ]
            }
          },
          "description": "The `type` and `id` of the\nrequested shield information barrier segment."
        },
        "restricted_segment": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "example": "1910967",
              "description": "The ID reference of the\nrestricted shield information barrier segment."
            },
            "type": {
              "type": "string",
              "description": "The type of the shield information segment",
              "example": "shield_information_barrier_segment",
              "enum": [
                "shield_information_barrier_segment"
              ]
            }
          },
          "description": "The `type` and `id` of the\nrestricted shield information barrier segment."
        }
      }
    }
  ]
}