A valid request URL is required to generate request examples{
"ConnectorId": "<string>",
"WorkspaceId": "<string>",
"ConnectorType": "<string>",
"AutomationSend": true,
"AutomationRetryInterval": 123,
"AutomationMaxAttempts": 123,
"AutomationReceive": true,
"ReceiveInterval": "<string>",
"MaxWorkers": 123,
"MaxFiles": 123,
"SendFolder": "<string>",
"ReceiveFolder": "<string>",
"SentFolder": "<string>",
"SaveToSentFolder": true,
"SentFolderScheme": "<string>",
"LogLevel": "<string>",
"LogSubFolderScheme": "<string>",
"LogMessages": true,
"Other": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Return a single connectors
Returns a single connectors object using the specified key.
A valid request URL is required to generate request examples{
"ConnectorId": "<string>",
"WorkspaceId": "<string>",
"ConnectorType": "<string>",
"AutomationSend": true,
"AutomationRetryInterval": 123,
"AutomationMaxAttempts": 123,
"AutomationReceive": true,
"ReceiveInterval": "<string>",
"MaxWorkers": 123,
"MaxFiles": 123,
"SendFolder": "<string>",
"ReceiveFolder": "<string>",
"SentFolder": "<string>",
"SaveToSentFolder": true,
"SentFolderScheme": "<string>",
"LogLevel": "<string>",
"LogSubFolderScheme": "<string>",
"LogMessages": true,
"Other": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Path Parameters
The key ConnectorId
Query Parameters
Select structural property
Response
connectors response
The connector Id.
The workspace that the connector belongs to.
The connector type, such as AS2, X12, or MySQL.
When set to True, the connector automatically processes files in the Send folder.
The length of time that the application waits after an error, in minutes, before trying to send the file again. When set to 0, the connector tries to send the file every interval.
The maximum number of times that the connector tries to process the input file in the event that failures are encountered. When set to 0, the connector retries the file indefinitely.
When set to True, the connector tries to automatically receive files at the specified ReceiveInterval.
The interval at which the connector tries to receive files if AutomationReceive is set to True.
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 is used.
The maximum number of files that are 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 is used.
The folder where the connector picks up files to be processed.
The folder where the connector places received files.
The folder where the connector places files after they have been processed.
When set to True, the connector keeps a copy of sent messages in the Sent folder.
Instructs the connector to group files in the Sent folder according to the selected interval. Available values are 'yyyy-MM-dd, @weekly, yyyy-MM, yyyy', corresponding to daily, weekly, monthly, and yearly.
The verbosity of logs generated when writing transcation logs. Available values are 'None, Error, Warning, Info, Debug, Trace'.
Instructs the connector to group files in the Logs folder according to the selected interval. Available values are 'yyyy-MM-dd, @weekly, yyyy-MM, yyyy', corresponding to daily, weekly, monthly, and yearly.
When set to True, the connector keeps a copy of the message with the message logs in the Logs directory.
The list of properties above is not comprehensive. You can use the API to set any property not listed above on a connector, using the same name/value format. All available connector default properties are returned in a GET request.