Integration Server 10.7 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client.sftp:get
 
pub.client.sftp:get
WmPublic. Retrieves a file from a remote SFTP server and saves it on the local machine.
Input Parameters
sessionKey
String Unique key for the current SFTP session. The sessionKey is returned by the pub.client.sftp:login service.
remoteFile
String Absolute or relative path of the remote file.
localFile
String Optional. Absolute or relative path of the local file.
If localFile is not specified, the pub.client.sftp:get service returns the retrieved file in the output parameter contentStream (as a java.io.InputStream object).
mode
String Optional. Specifies how the retrieved file is to be saved to the local file. Use this parameter only if you have specified a value for localFile. Set to:
*overwrite to overwrite the contents of the local file with the contents of the remote file. This is the default.
*append to append the entire contents of the remote file to the local file.
*resume to resume writing the contents of the remote file to the local file from the point at which the writing stopped during previous SFTP sessions.
Output Parameters
returnCode
String Standard SFTP protocol return code.
returnMsg
String Text message describing the return code.
contentStream
Object Conditional. A java.io.InputStream object.
The pub.client.sftp:get service returns the retrieved file in the output parameter contentStream (as a java.io.InputStream object) if localFile is not specified.
Usage Notes
You cannot execute SFTP commands in parallel using the same session key.