Box · Schema

Metadata field filter (multi-select)

Specifies the values to match for a `multiSelect` metadata field. When performing a search, the query will essentially perform an `OR` operation to match any template where any of the provided values match this field.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
View JSON Schema on GitHub

JSON Schema

box-metadatafieldfiltermultiselect-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MetadataFieldFilterMultiSelect",
  "title": "Metadata field filter (multi-select)",
  "type": "object",
  "x-box-resource-id": "metadata_field_filter_multi_select",
  "description": "Specifies the values to match for a `multiSelect` metadata\nfield. When performing a search, the query will essentially\nperform an `OR` operation to match any template where any of\nthe provided values match this field.",
  "example": {
    "category": [
      "online",
      "enterprise"
    ]
  },
  "additionalProperties": {
    "type": "array",
    "description": "A mapping between a metadata `multiSelect` field key and\nthe one or more values to match search results on.\n\nWhen performing a search, the query will essentially\nperform an `OR` operation to match any template where any of\nthe provided values match this field.",
    "example": [
      "online",
      "enterprise"
    ],
    "items": {
      "type": "string"
    },
    "x-box-example-key": "category"
  }
}