Download files for this connector.

Error

A valid request URL is required to generate request examples

[
  {
    "MessageId": "<string>",
    "Subfolder": "<string>",
    "File": "<string>",
    "FileSize": "<string>",
    "ErrorMessage": "<string>"
  }
]

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

POST

receiveFile

Error

A valid request URL is required to generate request examples

[
  {
    "MessageId": "<string>",
    "Subfolder": "<string>",
    "File": "<string>",
    "FileSize": "<string>",
    "ErrorMessage": "<string>"
  }
]

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

授权

x-cdata-authtoken

string

header

必填

请求体

application/json

WorkspaceId

string

The workspace id of the connector.

ConnectorId

string

The id of the connector. Required.

PortId

string

The id of the port.

File

string

The file to be downloaded. When file is not supplied, all files will be downloaded based on the connector's settings.

RemotePath

string

The path to override the Remote Path settings in the connector(Only used for FTP, SFTP)

响应

The action result

MessageId

string

The message id of the file.

Subfolder

string

The subfolder of the file.

File

string

The name of the file.

FileSize

string

The size of the file.

ErrorMessage

string

When multiple files are transferred over the same connection, this will return the error message if an individual file transfer failed. If this is empty, the file transfer was successful.

Import and update the internal Data Encryption Key (DEK)Requeue a message.

系统 API

API Reference

Download files for this connector.

授权

请求体

响应