Join BoxWorks 2024 to discover what's possible with content and AI!

Metadata query index

A metadata query index

id string

example-9876

The ID of the metadata query index.

type string

examplemetadata_query_index

Value is always metadata_query_index

fields object array

A list of template fields which make up the index.

[fields].key string

examplevendor name

The metadata template field key.

[fields].sort_direction string

exampleasc

The sort direction of the field.

Value is one of asc,desc

status string

exampleactive

The status of the metadata query index

Value is one of building,active,disabled

Response Example

{
  "id": "-9876",
  "type": "metadata_query_index",
  "fields": [
    {
      "key": "vendor name",
      "sort_direction": "asc"
    }
  ],
  "status": "active"
}