跳转到主要内容
PUT
Error

授权

x-cdata-authtoken
string
header
必填

路径参数

ConnectorId
string
必填

The key ConnectorId

请求体

application/json

The connectors entity to update.

ConnectorId
string
必填

The id of the connector.

WorkspaceId
string

The workspace of the connector.

ConnectorType
string

The type of the connector.

AutomationSend
boolean

When set to True, the connector will automatically process files in the Send folder.

AutomationRetryInterval
integer<int32>

The length of time that the application will wait after an error, in minutes, before attempting to send the file again. If set to 0, the connector will attempt to retry the file every interval.

AutomationMaxAttempts
integer<int32>

The maximum number of times that the connector will attempt to process the input file in the event that failures are encountered. If set to 0, the connector will attempt to retry the file indefinitely.

AutomationReceive
boolean

When set to True, the connector will attempt to automatically receive files at the specified ReceiveInterval.

ReceiveInterval
string

The interval at which the connector will attempt to receive files if AutomationReceive is set to True.

MaxWorkers
integer<int32>

The maximum number of workers to assign from the worker pool when processing files on this connector. If not set, the default setting from the Settings tab of the application will be used.

MaxFiles
integer<int32>

The maximum number of files that will be processed for this connector each time workers are assigned to this connector. If not set, the default setting from the Settings tab of the application will be used.

SendFolder
string

This is the folder where the connector will pick up files to be processed.

ReceiveFolder
string

This is the folder where the connector will place received files.

SentFolder
string

This is the folder where the connector will place files after they have been processed.

SaveToSentFolder
boolean

When set to True, the connector will keep a copy of sent messages in the Sent folder.

SentFolderScheme
string

This setting governs the subfolder structure that is used within the Sent folder. Available values are Daily, Weekly, Monthly, and Yearly.

LogLevel
string

The log level used when writing transcation logs. Available values are None, Error, Warning, Info, Debug, and Trace.

LogSubFolderScheme
string

This setting governs the subfolder structure that is used within the Logs folder. Available values are Daily, Weekly, Monthly, and Yearly.

LogMessages
boolean

When checked, the connector will keep a copy of the message next to the logs for the message in the Logs directory.

响应

EntitySet connectors

ConnectorId
string
必填

The id of the connector.

WorkspaceId
string

The workspace of the connector.

ConnectorType
string

The type of the connector.

AutomationSend
boolean

When set to True, the connector will automatically process files in the Send folder.

AutomationRetryInterval
integer<int32>

The length of time that the application will wait after an error, in minutes, before attempting to send the file again. If set to 0, the connector will attempt to retry the file every interval.

AutomationMaxAttempts
integer<int32>

The maximum number of times that the connector will attempt to process the input file in the event that failures are encountered. If set to 0, the connector will attempt to retry the file indefinitely.

AutomationReceive
boolean

When set to True, the connector will attempt to automatically receive files at the specified ReceiveInterval.

ReceiveInterval
string

The interval at which the connector will attempt to receive files if AutomationReceive is set to True.

MaxWorkers
integer<int32>

The maximum number of workers to assign from the worker pool when processing files on this connector. If not set, the default setting from the Settings tab of the application will be used.

MaxFiles
integer<int32>

The maximum number of files that will be processed for this connector each time workers are assigned to this connector. If not set, the default setting from the Settings tab of the application will be used.

SendFolder
string

This is the folder where the connector will pick up files to be processed.

ReceiveFolder
string

This is the folder where the connector will place received files.

SentFolder
string

This is the folder where the connector will place files after they have been processed.

SaveToSentFolder
boolean

When set to True, the connector will keep a copy of sent messages in the Sent folder.

SentFolderScheme
string

This setting governs the subfolder structure that is used within the Sent folder. Available values are Daily, Weekly, Monthly, and Yearly.

LogLevel
string

The log level used when writing transcation logs. Available values are None, Error, Warning, Info, Debug, and Trace.

LogSubFolderScheme
string

This setting governs the subfolder structure that is used within the Logs folder. Available values are Daily, Weekly, Monthly, and Yearly.

LogMessages
boolean

When checked, the connector will keep a copy of the message next to the logs for the message in the Logs directory.