Box · Schema

Integration mapping (Base)

A base representation of an integration mapping object.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string A unique identifier of a folder mapping (part of a composite key together with `integration_type`)
integration_type string Identifies the Box partner app, with which the mapping is associated. Currently only supports Slack. (part of the composite key together with `id`)
View JSON Schema on GitHub

JSON Schema

box-integrationmapping-base-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IntegrationMapping--Base",
  "title": "Integration mapping (Base)",
  "type": "object",
  "x-box-resource-id": "integration_mapping--base",
  "x-box-tag": "integration_mappings",
  "x-box-variant": "base",
  "x-box-variants": [
    "base",
    "standard",
    "mini"
  ],
  "description": "A base representation of an\nintegration mapping object.",
  "properties": {
    "id": {
      "type": "string",
      "nullable": false,
      "example": "12345",
      "description": "A unique identifier of a folder mapping\n(part of a composite key together\nwith `integration_type`)"
    },
    "integration_type": {
      "type": "string",
      "nullable": false,
      "description": "Identifies the Box partner app,\nwith which the mapping is associated.\nCurrently only supports Slack.\n(part of the composite key together with `id`)",
      "example": "slack",
      "enum": [
        "slack"
      ]
    }
  }
}