Skip to main content
POST
Error

Authorizations

x-cdata-authtoken
string
header
required

Body

application/json
ConnectorId
string
required

The connector Id.

WorkspaceId
string

The Id of the workspace containing the connector.

PortId
string

The Id of the port to use for the connection.

File
string

The specific filename to receive. If omitted, all files matching the connector settings are received. Only available for FTP, SFTP, and S3 connectors.

RemotePath
string

Sets the remote path on the server from which the application downloads files. Use a comma-separated list to supply paths to multiple folders. Only available for FTP, SFTP, and S3 connectors.

Response

The action result

MessageId
string

The message Id associated with the file.

Subfolder
string

The subfolder path where the received file was stored.

File
string

The name of the received file(s).

FileSize
string

The size of the received file(s) in bytes.

ErrorMessage
string

When multiple files are transferred over the same connection, this returns an error message when an individual file transfer fails. If this is empty, the file transfer succeeded.