Full path: /system/sftp/retrieve
Retrieves a file from the SFTP server. This function returns true if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter (see below).
Parameters
Name |
Type |
Description |
|---|---|---|
SFTP Connection |
SFTP Connection |
Mandatory parameter. This is a FlowForce object that establishes an SFTP connection. To get the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step. |
Source file |
string |
Mandatory parameter. Specifies the source path of the file to be retrieved. |
Target file |
string |
Mandatory parameter. Specifies the local destination file path. If you specify a relative path, it will be resolved against the working directory. If you use an absolute path, the path specified in the Working directory parameter will not be used. |
Overwrite target |
boolean |
Optional parameter. Set this to true if a destination file with the same name should be overwritten. The default value is false. |
Abort on error |
boolean |
Optional parameter. If job execution fails and the Abort on error parameter is set to true, the job execution will be aborted. The default value is true. |
Working directory |
string |
Specifies the working directory against which all local relative paths will be resolved. |
