DownloadAttachment
Downloads the attachment or attachments associated with a specific entity in Salesforce.
Input
| Name | Type | Accepts Output Streams | Description |
| ObjectId | String | False | The Id of the object to download attachments for. |
| Id | String | False | The Id of the attachment to download. If neither Name nor Id are specified, all attachments will be downloaded. |
| Name | String | False | The name of the attachment to download. If neither Name nor Id are specified, all attachments will be downloaded. |
| LocalPath | String | False | The local path to save the files to. If no path is specified, the file is kept in memory in the FileData output. |
| LightningMode | String | False | Defaults to false. If set to 'True' the file will be downloaded from the list of 'Salesforce Files'. If you used UploadAttachment with 'LightningMode' to true, you should also set it to true when using this stored procedure, to download the uploaded file. Also downloading the attachment by name is not supported when this is set to true. You should either specify the Id or ObjectId of the file. |
| Encoding | String | False | The encoding of the data that will be output to FileData.
The allowed values are NONE, BASE64. The default value is BASE64. |
| FileStream | String | True | An instance of an output stream where file data is written to. Only used if LocalPath is not set. |
Result Set Columns
| Name | Type | Description |
| FileId | String | The id of the file. |
| Success | String | The status of the download for a specific file. |
| FileName | String | The name of the downloaded file. |
| FullPath | String | The full path (including name) of the downloaded file. |
| FileData | String | The file data output, if the LocalPath input is empty. |
| FailureMessage | String | In multi-file download mode, shows the failure message of any unsuccessful download. |