Full path: /system/sftp/retrieve
Retrieves a file from an SFTP Server.
This function returns Boolean true if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter, as further described below.
Parameters
Name |
Type |
Description |
|---|---|---|
SFTP Connection |
SFTP Connection |
A FlowForce object that provides the SFTP connection. To obtain the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step.
Mandatory parameter. |
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. |
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 |
This Boolean parameter determines what should be the return value of the function if execution fails. If this parameter is false, the function will return Boolean false as well. If this parameter is true, the job execution is aborted. The default value is true. |
Working directory |
string |
Specifies the working directory against which all local relative paths will be resolved. |
