POST api/v2/sftp

downloads a file specified by the request to an SFTP server.

Request Information

URI Parameters

None.

Body Parameters

download file request

SuiteBridge.Models.Ftp.FtpDownLoadFileRequest

Name	Description	Type	Additional information
RemoteFile	The name of the remote file to download and is either an absolute file path, or a relative path based on RemotePath	string	None.

Request Formats

application/json, text/json

Sample:

{
  "RemoteFile": "sample string 1"
}

application/xml, text/xml

Sample:

<FtpDownLoadFileRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RemoteFile>sample string 1</RemoteFile>
</FtpDownLoadFileRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

file response with status 200 OK on successful download

SuiteBridge.Models.Ftp.FtpDownLoadFileResponse

Name	Description	Type	Additional information
RemoteFile	downloaded file	SuiteBridge.Models.Ftp.FtpRemoteFile	None.

Response Formats

application/json, text/json

Sample:

{
  "RemoteFile": {
    "FileName": "sample string 1",
    "FileContent": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<FtpDownLoadFileResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RemoteFile>
    <FileName>sample string 1</FileName>
    <FileContent>sample string 2</FileContent>
  </RemoteFile>
</FtpDownLoadFileResponse>