DownloadFile
Downloads a File. Requires the files.content.read scope.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| FileType | String | True | False | The type of file (file or paper).
The allowed values are file, paper. |
| Path | String | False | False | The path of the file or folder to download. |
| Id | String | False | False | The ID of the paper document to download. This ID can be found in the URL of the paper and it is represented by the last value after the last dash. For example: https://paper.dropbox.com/doc/My-Paper-doc--AM_HNkNcgpz5hF11eBZ3qlcEAg-XplVjr3tCQhCVoerMMkEP The id of this paper would be XplVjr3tCQhCVoerMMkEP. |
| Revision | String | False | False | The revision value of the paper document to download, for example 'rev:a1c10ce0dd78'. |
| ExportFormat | String | False | False | The format of the document to download (HTML or markdown).
The default value is html. |
| AsZip | Boolean | False | False | Download a folder in a zip format. Required to be set to true to download a folder. |
| DownloadTo | String | False | False | The folder path to download the file to. |
| FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if DownloadTo is not set. |
Result Set Columns
| Name | Type | Description |
| Success | String | Whether or not the file was successfully downloaded. |
| Name | String | The name of the file (including extension). |
| Id | String | A unique identifier for the file. |
| ClientModified | String | The modification time set by the desktop client when the file was added to Dropbox. |
| ServerModified | String | The last time the file was modified on Dropbox. |
| Revision | String | A unique identifier for the current revision of a file. |
| Size | String | The file size in bytes. |
| LowerCasePath | String | The lowercased full path in the user's Dropbox. |
| DisplayPath | String | The cased path to be used for display purposes only. |
| PreviewURL | String | The preview URL of the file. |
| IsDownloadable | String | If true, file can be downloaded directly; else the file must be exported. |
| HasExplicitSharedMembers | String | If true, the results will include a flag for each file indicating whether or not that file has any explicit members. |
| ContentHash | String | A hash of the file content. |
| Owner | String | The Paper doc owner's email address. |
| Title | String | The Paper doc title. |
| MimeType | String | MIME type of the export. This corresponds to ExportFormat specified in the request. |
| FileData | String | The file's data encoded in Base64 will be outputted if DownloadTo and FileStream inputs are not set. |