Download
Download a file from the remote FTP server.
Input
Name | Type | Required | Accepts Output Streams | Description |
RemoteFile | String | False | False | Specify the remote file name to be downloaded. |
RemotePath | String | False | False | Specify the remote path. If RemoteFile is not specified, all the files in this folder will be downloaded. |
LocalPath | String | False | False | The local path to store the downloaded files. |
LocalFile | String | False | False | The local name of the downloaded file. Not used when downloading remotely all the contents of a folder. |
Overwrite | String | False | False | Whether to overwrite Local Files.
The allowed values are true, false. The default value is true. |
TransferMode | String | False | False | The mode to be used to transfer the file.
The allowed values are DEFAULT, ASCII, BINARY. The default value is DEFAULT. |
IncludeSubFolders | String | False | False | To include subfolders for pattern search or not
The allowed values are true, false. The default value is false. |
FileStream | String | False | True | OutputStream to write the downloaded document. Only returned if LocalPath is not set. |
Result Set Columns
Name | Type | Description |
Success | String | This parameter sets whether the operation was successful or not. |
FileData | String | The downloaded file BASE64 encoded content. Only returned if LocalPath and FileStream is not set. |