Integration Server 10.3 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client.sftp:put
 
pub.client.sftp:put
WmPublic. Transfers a file to a remote SFTP server.
Input Parameters
sessionKey
String Unique key for the current SFTP session. The sessionKey is returned by the pub.client.sftp:login service.
contentStream
java.io.InputStream Optional. Data to be transferred to the remote file.
localFile
String Optional. Name of the local file to be appended to the remote file. Use localFile only if contentStream is not specified.
remoteFile
String Optional. Absolute or relative path of the remote file to which the local file is to be appended.
mode
String Optional. Specifies how the local file is to be transferred to the remote SFTP server. Set to:
*overwrite to overwrite the contents of the remote file with the contents of the local file. This is the default.
*append to append the entire contents of the local file to the remote file.
*resume to resume writing the contents of the local file to the remote file from the point the writing was stopped during previous SFTP sessions.
Output Parameters
returnCode
String Standard SFTP protocol return code.
returnMsg
String Text message describing the return code.
Usage Notes
If you specify contentStream, you must specify remoteFile. In this case, localFile is optional.
If you specify localFile, then remoteFile and contentStream are optional. In this case, the remote file will be given the same name as the local file.
You cannot execute SFTP commands in parallel using the same session key.