Back to DropboxFile Properties - Properties - Search
Search across property templates for particular property field values.
Input
type: object
properties:
data:
type: object
description: >
queries: Queries to search.
template_filter: Filter results to contain only properties associated with
these template IDs.
properties:
template_filter:
type: object
description: >
filter_some: Only templates with an ID in the supplied list will be
returned (a subset of templates will be returned).
other: None
filter_none: No templates will be filtered from the result (all
templates will be returned).
properties:
filter_some:
type: array
description: >-
Only templates with an ID in the supplied list will be returned (a
subset of templates will be returned).
items:
type: string
.tag:
title: Choice of TemplateFilter
type: string
enum:
- filter_some
- other
- filter_none
queries:
type: array
description: Queries to search.
items:
type: object
description: >
query: The property field value for which to search across
templates.
mode: The mode with which to perform the search.
logical_operator: The logical operator with which to append the
query.
properties:
query:
type: string
description: The property field value for which to search across templates.
logical_operator:
type: object
description: |
Logical operator to join search queries together.
or_operator: Append a query with an "or" operator.
other: None
properties:
.tag:
title: Choice of LogicalOperator
type: string
enum:
- or_operator
- other
mode:
type: object
description: |
field_name: Search for a value associated with this field name.
other: None
properties:
.tag:
title: Choice of PropertiesSearchMode
type: string
enum:
- field_name
- other
field_name:
type: string
description: Search for a value associated with this field name.
title: Data
Output
type: object
description: >
matches: A list (possibly empty) of matches for the query.
cursor: Pass the cursor into :route:`properties/search/continue` to continue
to receive search results. Cursor will be null when there are no more results.
properties:
matches:
type: array
description: A list (possibly empty) of matches for the query.
items:
type: object
description: >
id: The ID for the matched file or folder.
path: The path for the matched file or folder.
is_deleted: Whether the file or folder is deleted.
property_groups: List of custom property groups associated with the
file.
properties:
path:
type: string
description: The path for the matched file or folder.
is_deleted:
type: boolean
description: Whether the file or folder is deleted.
id:
type: string
description: The ID for the matched file or folder.
property_groups:
type: array
description: List of custom property groups associated with the file.
items:
type: object
description: >
A subset of the property fields described by the corresponding
:type:`PropertyGroupTemplate`. Properties are always added to a
Dropbox file as a :type:`PropertyGroup`. The possible key names
and value types in this group are defined by the corresponding
:type:`PropertyGroupTemplate`.
template_id: A unique identifier for the associated template.
fields: The actual properties associated with the template. There
can be up to 32 property types per template.
properties:
fields:
type: array
description: >-
The actual properties associated with the template. There can
be up to 32 property types per template.
items:
type: object
description: >
Raw key/value data to be associated with a Dropbox file.
Property fields are added to Dropbox files as a
:type:`PropertyGroup`.
name: Key of the property field associated with a file and
template. Keys can be up to 256 bytes.
value: Value of the property field associated with a file
and template. Values can be up to 1024 bytes.
properties:
name:
type: string
description: >-
Key of the property field associated with a file and
template. Keys can be up to 256 bytes.
value:
type: string
description: >-
Value of the property field associated with a file and
template. Values can be up to 1024 bytes.
template_id:
type: string
description: A unique identifier for the associated template.
cursor:
type: string
description: >-
Pass the cursor into :route:`properties/search/continue` to continue to
receive search results. Cursor will be null when there are no more
results.