Box · Schema

Shield information barrier report

A standard representation of a shield information barrier report object

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-shieldinformationbarrierreport-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShieldInformationBarrierReport",
  "title": "Shield information barrier report",
  "type": "object",
  "x-box-resource-id": "shield_information_barrier_report",
  "x-box-tag": "shield_information_barrier_reports",
  "x-box-variants": [
    "base",
    "standard"
  ],
  "x-box-variant": "standard",
  "description": "A standard representation\nof a shield information barrier report object",
  "allOf": [
    {
      "$ref": "#/components/schemas/ShieldInformationBarrierReport--Base"
    },
    {
      "properties": {
        "shield_information_barrier": {
          "allOf": [
            {
              "$ref": "#/components/schemas/ShieldInformationBarrierReference"
            }
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "error",
            "done",
            "cancelled"
          ],
          "description": "Status of the shield information report",
          "example": "pending"
        },
        "details": {
          "allOf": [
            {
              "$ref": "#/components/schemas/ShieldInformationBarrierReportDetails"
            }
          ]
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "example": "2020-06-26T18:44:45.869Z",
          "description": "ISO date time string when this\nshield information barrier report object was created."
        },
        "created_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Base"
            },
            {
              "description": "The user who created this shield information barrier report."
            }
          ]
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "example": "2020-07-26T18:44:45.869Z",
          "description": "ISO date time string when this\nshield information barrier report was updated."
        }
      }
    }
  ]
}