Box · Schema
Metadata query index
A metadata query index
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the metadata query index. |
| type | string | Value is always `metadata_query_index` |
| status | string | The status of the metadata query index |
| fields | array | A list of template fields which make up the index. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/MetadataQueryIndex",
"title": "Metadata query index",
"type": "object",
"x-box-resource-id": "metadata_query_index",
"x-box-tag": "search",
"description": "A metadata query index",
"required": [
"type",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "-9876",
"description": "The ID of the metadata query index."
},
"type": {
"type": "string",
"description": "Value is always `metadata_query_index`",
"example": "metadata_query_index",
"nullable": false
},
"status": {
"type": "string",
"description": "The status of the metadata query index",
"example": "active",
"enum": [
"building",
"active",
"disabled"
],
"nullable": false
},
"fields": {
"type": "array",
"description": "A list of template fields which make up the index.",
"items": {
"type": "object",
"description": "The field which makes up the index.",
"allOf": [
{
"properties": {
"key": {
"type": "string",
"example": "vendor name",
"description": "The metadata template field key."
},
"sort_direction": {
"type": "string",
"example": "asc",
"description": "The sort direction of the field.",
"enum": [
"asc",
"desc"
]
}
}
}
]
}
}
}
}