Dropbox Query Operations
Version: 17.07
Supported Since: 17.07
These connector operations can be used to preform entity queries (such as listing and searching) on Dropbox. The raw API results returned by Dropbox will be provided as either a Dropbox Java SDK object or a JSON string, in the message payload or within a scope variable, depending on the configuration of the parent egress connector.
| These operations are compatible only with the Dropbox Egress Connector. Accordingly, they automatically become available when you have selected the Dropbox Connector dependency. |
Among the parameters of each operation,
-
*marked fields are mandatory. -
#marked fields support placeholder expressions.
List Entities
The List Entities operation can be used to list entities at a specified path on the connected Dropbox account. It is compatible with the Dropbox API operation list_folder.
Parameters
Path |
Basic |
Absolute path of the folder whose content should be listed |
List under Shared Link |
Basic |
This option can be used to list entities under a given shared link. When this option is used, Path should be relative to root of the shared link. Recursive option is not supported when this option is being used. |
Shared Link |
Basic |
Available under the List under Shared Link option, this can be used to specify the link URL for listing content. |
Link Password |
Basic |
Available under the List under Shared Link option, this can be used to specify the shared link password, in case the shared link is password-protected. |
Recursive |
Advanced |
Enabling this will cause the result to include entities from subdirectories of the specified path as well. |
Include Deleted |
Advanced |
Enabling this will return previously deleted entities as well, along with currently existing ones. |
Include Media Info |
Advanced |
Enabling this will include additional information for media files (photos and videos) being returned in the result. |
Include Has Explicit Shared Members |
Advanced |
If enabled, the results will include a flag for each entity indicating whether it has any explicit members. |
Include Mounted Folders |
Advanced |
If enabled, the results will include entries from mounted folders (app folder, shared folder and team folder) as well. |
Limit |
Advanced |
Specifies the maximum number of results to be included in the listing. Defaults to |
Search
The Search connector operation can be used to search for Dropbox entities (files/folders). It is compatible with the Dropbox API operation search.
Parameters
Path |
Basic |
Absolute path of the search root, from which the search would start. |
Query |
Basic |
The search query. Dropbox would split this query at spaces, into multiple tokens, and utilize them based on the search API specification (e.g. for file name searching, the last token would be used for prefix matching). |
Search Mode |
Advanced |
Specifies whether to search only file names ( |
Result Count |
Advanced |
Specifies the maximum number of results to be included in the response. Defaults to |
List Revisions
The List Revisions operation can be used to list the revisions of a Dropbox entity. It is compatible with the Dropbox API operation list_revisions.
Parameters
Path |
Basic |
Absolute path of the entity whose revisions should be listed.
If Revisions Mode (under Advanced) is set to |
Revisions Mode |
Advanced |
Whether the provided identifier (under Path) is an actual file path ( |
Limit |
Advanced |
Specifies the maximum number of results to be included in the listing. Defaults to |
Get Metadata
The Get Metadata operation can be used to retrieve metadata of a Dropbox entity, which includes its size, current revision, hash, modification timestamps, etc. It is compatible with the Dropbox API operation get_metadata.
Parameters
Path |
Basic |
Absolute path of the entity whose metadata should be obtained. |
Include Deleted |
Advanced |
If this is disabled, the operation will raise an error if the requested path (entity) has been deleted. Hence having it enabled facilitates obtaining of metadata for a previously deleted entity. |
Include Media Info |
Advanced |
Enabling this will include additional information, in case the queried entity is a media file (photo or video). |
In this topic
In this topic