DownloadFile
Downloads the contents of a file from Box to a local system or application.
Input
| Name | Type | Accepts Output Streams | Description |
| FileID | String | False | Identifier of the file to be downloaded. |
| FileVersionID | String | False | Identifier of a specific file version to download. If not provided, the most recent version is downloaded. |
| DownloadTo | String | False | The file path where the downloaded file should be saved locally. |
| AsUserId | String | False | Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts. |
| UseSimpleName | Boolean | False | When set to true, removes unsupported special characters from the file name to ensure compatibility with operating systems that restrict certain characters. Characters removed include forward slash, backslash, colon, asterisk, question mark, double-quote, less than, greater than, and vertical bar.
The default value is false. |
| Name | String | False | The name to use when saving the file after download. If left blank, the original file name is used. |
| FileStream | String | True | An output stream instance where file data is written, used when DownloadTo is not specified. |
Result Set Columns
| Name | Type | Description |
| Success | String | Indicates whether the file download operation completed successfully. |
| FileData | String | The downloaded file data encoded in Base64, returned when neither DownloadTo nor FileStream are specified. |