Excel Add-In for Dropbox

Build 24.0.9062

DownloadFile

Downloads a File. Requires the files.content.read scope.

Execute

Refer to the query examples below for using the procedure:

query = "EXEC DownloadFile Id = 'id:LAvTtXjyNEYAAAAAAAAADg', DownloadTo = 'C:/Users/User/Downloads'";
query = "EXEC DownloadFile Revision = 'rev:60fc8c685aace89083943', DownloadTo = 'C:/Users/User/Downloads'";
query = "EXEC DownloadFile Path = '/Test Folder/Test File.txt', DownloadTo = 'C:/Users/User/Downloads'";

Input

Name Type Required Description
Id String False The ID of the document to download.
Revision String False The revision of the document to download, for example 'rev:a1c10ce0dd78'.
Path String False The path of the file or folder to download.
AsZip Boolean False Download a folder in a zip format. Must be set to true to download a folder.
DownloadTo String False The folder path to download the file to.

Result Set Columns

Name Type Description
Success String Whether or not the file was successfully downloaded.
Id String A unique identifier for the file.
Name String The name of the file (including extension).
Revision String A unique identifier for the current revision of a file.
DisplayPath String The cased path to be used for display purposes only.
LowerCasePath String The lowercased full path in the user's Dropbox.
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.
Size String The file size in bytes.
ContentHash String A hash of the file content.
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.
FileData String The file's data encoded in Base64 will be outputted if DownloadTo and FileStream inputs are not set.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062