Box · Schema

Integration mapping (Mini)

A mini representation of an integration mapping object.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-integrationmapping-mini-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IntegrationMapping--Mini",
  "title": "Integration mapping (Mini)",
  "type": "object",
  "x-box-resource-id": "integration_mapping--mini",
  "x-box-tag": "integration_mappings",
  "x-box-variant": "mini",
  "description": "A mini representation of an\nintegration mapping object.",
  "allOf": [
    {
      "$ref": "#/components/schemas/IntegrationMapping--Base"
    },
    {
      "properties": {
        "partner_item_id": {
          "type": "string",
          "example": "C12351346",
          "description": "ID of the mapped partner item",
          "nullable": false
        },
        "partner_item_type": {
          "type": "string",
          "example": "channel",
          "enum": [
            "channel"
          ],
          "description": "Domain-specific type of the mapped partner item",
          "nullable": false
        },
        "box_item_id": {
          "type": "string",
          "example": "123124351",
          "description": "ID of the Box item mapped to the object referenced in `partner_item_id`",
          "nullable": false
        },
        "box_item_type": {
          "type": "string",
          "example": "folder",
          "enum": [
            "folder"
          ],
          "description": "Type of the Box object referenced in `box_item_id`",
          "nullable": false
        }
      }
    }
  ]
}