Metadata filter
A metadata template used to filter the search results.Attributes and example
Attributes and example
| Property | Type | Required | Description |
|---|---|---|---|
scope | enum<string> | No | Specifies the scope of the template to filter search results by. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box. Available options: global, enterprise, enterprise_{enterprise_id}. |
templateKey | string | No | The key of the template used to filter search results. In many cases the template key is automatically derived of its display name, for example Contract Template would become contractTemplate. In some cases the creator of the template will have provided its own template key. Please [list the templates for an enterprise][list], or get all instances on a [file][file] or [folder][folder] to inspect a template’s key. [list]: /reference/get-metadata-templates-enterprise [file]: /reference/get-files-id-metadata [folder]: /reference/get-folders-id-metadata |
filters | object | No | Specifies which fields on the template to filter the search results by. When more than one field is specified, the query performs a logical AND to ensure that the instance of the template matches each of the fields specified. |
Example
Metadata query search results
A page of files and folders that matched the metadata query.Attributes and example
Attributes and example
| Property | Type | Required | Description |
|---|---|---|---|
entries | array of Metadata query search result item | No | The mini representation of the files and folders that match the search terms. By default, this endpoint returns only the most basic info about the items. To get additional fields for each item, including any of the metadata, use the fields attribute in the query. |
limit | integer | No | The limit that was used for this search. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. |
next_marker | string | No | The marker for the start of the next page of results. |
Example
Search Result (including Shared Link)
A single of files, folder or web link that matched the search query, including the additional information about the shared link through which the item has been shared with the user. This response format is only returned when theinclude_recent_shared_links query parameter has been set to true.
Attributes and example
Attributes and example
| Property | Type | Required | Description |
|---|---|---|---|
accessible_via_shared_link | string | No | The optional shared link through which the user has access to this item. This value is only returned for items for which the user has recently accessed the file through a shared link. For all other items this value will return null. |
item | Search result item | No | The file, folder or web link that matched the search query. |
type | string | No | The result type. The value is always search_result. |
Example
Search Results
A list of files, folders and web links that matched the search query.Attributes and example
Attributes and example
| Property | Type | Required | Description |
|---|---|---|---|
total_count | integer | No | One greater than the offset of the last entry in the search results. The total number of entries in the collection may be less than total_count. |
limit | integer | No | The limit that was used for this search. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. |
offset | integer | No | The 0-based offset of the first entry in this set. This will be the same as the offset query parameter used. |
type | enum<string> | Yes | Specifies the response as search result items without shared links. Available options: search_results_items. |
entries | array of Search results item | No | The search results for the query provided. |
Example
Search Results (including Shared Links)
A list of files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user. This response format is only returned when theinclude_recent_shared_links query parameter has been set to true.
Attributes and example
Attributes and example
| Property | Type | Required | Description |
|---|---|---|---|
total_count | integer | No | One greater than the offset of the last entry in the search results. The total number of entries in the collection may be less than total_count. |
limit | integer | No | The limit that was used for this search. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. |
offset | integer | No | The 0-based offset of the first entry in this set. This will be the same as the offset query parameter used. |
type | enum<string> | Yes | Specifies the response as search result items with shared links. Available options: search_results_with_shared_links. |
entries | array of Search Result (including Shared Link) | No | The search results for the query provided, including the additional information about any shared links through which the item has been shared with the user. |
Example
