DownloadFile
Downloads a File.
Input
| Name | Type | Description |
| FileID | String | The Id of the file to download. |
| FileVersionID | String | The Id of the file version to download. If not fed, it will download the latest version. |
| DownloadTo | String | Where to download the file. |
| AsUserId | String | The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts. |
| UseSimpleName | Boolean | When enabled, removes special characters from the filename. Some operating systems prohibit certain characters in file names that Box allows in its filenames. Set this to true to remove these characters in the downloaded file's name. The cmdlet removes forward and back slash, colon, asterisk, question mark, double-quote, less than and greater than, and bar.
The default value is false. |
| Name | String | The name used to store the file after the download. If left empty, the original file name will be used. |
Result Set Columns
| Name | Type | Description |
| Success | String | Whether or not the file was successfully downloaded. |
| FileData | String | File data that will be outputted encoded in Base64 if the DownloadTo and FileStream inputs are empty. |