Dropbox: File properties schemas
23 Dropbox schemas with complete fields and constraints.
← File properties operations · All schemas
Add a template associated with a team — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | |
description | string | Required within parent | |
fields | array | Required within parent | |
fields[] | Model | Each item | Expand Add a template associated with a team — request body — body fields item |
Referenced models: Add a template associated with a team — request body — body fields item
Add a template associated with a team — request body — body fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate. |
name | string | Required within parent | |
description | string | Required within parent | |
type | Model | Required within parent | Expand Add a template associated with a team — request body — body fields item type |
Referenced models: Add a template associated with a team — request body — body fields item type
Add a template associated with a team — request body — body fields item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: string |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: string |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:string)$) |
Add a template associated with a team — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
template_id | string | Required within parent | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
Add property groups to a Dropbox file — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*|id:.*|(ns:[0-9]+(/.*)?))$ |
property_groups | array | Required within parent | |
property_groups[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item
Add property groups to a Dropbox file — request body — body property groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A subset of the property fields described by the corresponding PropertyGroupTemplate. Properties are always added to a Dropbox file as a PropertyGroup. The possible key names and value types in this group are defined by the corresponding PropertyGroupTemplate. |
template_id | string | Required within parent | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
fields | array | Required within parent | |
fields[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item fields item |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item
Add property groups to a Dropbox file — request body — body property groups item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox files as a PropertyGroup. |
name | string | Required within parent | |
value | string | Required within parent |
Add, update or remove properties associated with the supplied file and templates — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*|id:.*|(ns:[0-9]+(/.*)?))$ |
update_property_groups | array | Required within parent | |
update_property_groups[] | Model | Each item | Expand Add, update or remove properties associated with the supplied file and templates — request body — body update property groups item |
Referenced models: Add, update or remove properties associated with the supplied file and templates — request body — body update property groups item
Add, update or remove properties associated with the supplied file and templates — request body — body update property groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Property routes |
template_id | string | Required within parent | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
add_or_update_fields | JSON | Optional | |
add_or_update_fields (anyOf 1) | array | Alternative | |
add_or_update_fields (anyOf 1)[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item fields item |
add_or_update_fields (anyOf 2) | null | Alternative | |
remove_fields | JSON | Optional | |
remove_fields (anyOf 1) | array | Alternative | |
remove_fields (anyOf 1)[] | string | Each item | |
remove_fields (anyOf 2) | null | Alternative |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item fields item
Get the schema for a specified template — file Properties templates Get For Team — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | |
description | string | Required within parent | |
fields | array | Required within parent | |
fields[] | Model | Each item | Expand Get the schema for a specified template — file Properties templates Get For Team — response body — fields item |
Referenced models: Get the schema for a specified template — file Properties templates Get For Team — response body — fields item
Get the schema for a specified template — file Properties templates Get For Team — response body — fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate. |
name | string | Required within parent | |
description | string | Required within parent | |
type | Model | Required within parent | Expand Get the schema for a specified template — file Properties templates Get For Team — response body — fields item type |
Referenced models: Get the schema for a specified template — file Properties templates Get For Team — response body — fields item type
Get the schema for a specified template — file Properties templates Get For Team — response body — fields item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: string |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: string |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:string)$) |
Get the template identifiers for a team — file Properties templates List For Team — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
template_ids | array | Required within parent | |
template_ids[] | string | Each item | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
Overwrite property groups associated with a file — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*|id:.*|(ns:[0-9]+(/.*)?))$ |
property_groups | array | Required within parent | Minimum items: 1 |
property_groups[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item
Permanently removes the specified property group from the file — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*|id:.*|(ns:[0-9]+(/.*)?))$ |
property_template_ids | array | Required within parent | |
property_template_ids[] | string | Each item | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
Search across property templates for particular property field values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
queries | array | Required within parent | Minimum items: 1 |
queries[] | Model | Each item | Expand Search across property templates for particular property field values — request body — body queries item |
template_filter | Model | Optional | Expand Search across property templates for particular property field values — request body — body template filter |
Referenced models: Search across property templates for particular property field values — request body — body queries item, Search across property templates for particular property field values — request body — body template filter
Search across property templates for particular property field values — request body — body queries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
query | string | Required within parent | |
mode | Model | Required within parent | Expand Search across property templates for particular property field values — request body — body queries item mode |
logical_operator | Model | Optional | Expand Search across property templates for particular property field values — request body — body queries item logical operator |
Referenced models: Search across property templates for particular property field values — request body — body queries item logical operator, Search across property templates for particular property field values — request body — body queries item mode
Search across property templates for particular property field values — request body — body queries item logical operator
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Logical operator to join search queries together. |
$ (anyOf 1) | string | Alternative | One of: or_operator |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: or_operator |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:or_operator)$) |
Search across property templates for particular property field values — request body — body queries item mode
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: field_name |
$ (anyOf 1).field_name | string | Required within parent | |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:field_name)$) |
Search across property templates for particular property field values — request body — body template filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: filter_none |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: filter_some |
$ (anyOf 2).filter_some | array | Required within parent | Minimum items: 1 |
$ (anyOf 2).filter_some[] | string | Each item | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: filter_none |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:filter_some|filter_none)$) |
Search across property templates for particular property field values — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
matches | array | Required within parent | |
matches[] | Model | Each item | Expand Search across property templates for particular property field values — response body — matches item |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Minimum length: 1 |
cursor (anyOf 2) | null | Alternative |
Referenced models: Search across property templates for particular property field values — response body — matches item
Search across property templates for particular property field values — response body — matches item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Minimum length: 1 |
path | string | Required within parent | |
is_deleted | boolean | Required within parent | |
property_groups | array | Required within parent | |
property_groups[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item
Update a template associated with a team — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
template_id | string | Required within parent | Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$ |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
add_fields | JSON | Optional | |
add_fields (anyOf 1) | array | Alternative | |
add_fields (anyOf 1)[] | Model | Each item | Expand Add a template associated with a team — request body — body fields item |
add_fields (anyOf 2) | null | Alternative |
Referenced models: Add a template associated with a team — request body — body fields item