DownloadFile
Downloads a file stored in an app's attachment field so it can be archived, processed externally, or analyzed offline.
Input
| Name | Type | Required | Description |
| FileKey | String | True | Identifier of the file to download, used to retrieve the correct file from the app's attachment data. |
| LocalPath | String | False | Local file-system path where the downloaded file is saved when writing directly to disk. |
| FileName | String | False | File name to use when saving the downloaded content, allowing you to control the output file's naming. |
| GuestSpaceId | String | False | Guest space containing the file. Should not be provided when the connection property GuestSpaceId is already set in the connection string. |
| Encoding | String | False | Encoding type applied to the FileData output when the file content is returned directly.
The allowed values are NONE, BASE64. The default value is BASE64. |
Result Set Columns
| Name | Type | Description |
| FileData | String | Raw file data returned when neither LocalPath nor FileStream input is supplied, enabling in-memory processing of the downloaded content. |
| Success | String | Indicates whether the operation completed successfully by returning a Boolean value. |