CData Sync exposes a REST API that complies with the OData 4.0 standard. You can use this API to query the configured connections, jobs, and job history. You can also start or cancel jobs. The reference to the REST API with Javascript and cURL code examples is available in the API tab of the admin console.

Job Management API

Endpoint	Supported Methods	Description
Jobs	GET,POST,PUT,DELETE	Retrieve or update the configuration for existing jobs, or create a new job.
Transformations	GET,POST,PUT,DELETE	Retrieve or update the configuration for existing transformations, or create a new transformations.
Tasks	GET,POST,PUT,DELETE	Retrieve or update the configuration for existing tasks of a Jobs, or add a new task to a job.
GetJobStatus	POST	Retrieve the status of all jobs or the status of each query within a specified Job.
ExecuteJob	POST	Start the specified Job.
ExecuteQuery	POST	Execute a subset of queries within a job. Both the job and the query must be specified.
CancelJob	POST	Cancel a currently running Job.
History	GET	Retrieve the history of previous Job runs.
GetJobLog	POST	Retrieve logs from previous job run(s).

Connection Management API

Endpoint	Supported Methods	Description
Connections	GET,POST,PUT,DELETE	Retrieve or update the configuration for existing connections, or add a new connection to the application.
TestConnection	POST	Test a previously created connection.
GetConnectionTables	POST	Retrieve a list of tables for a connection.
GetConnectionTableColumns	POST	Retrieve a list of columns for a table.

User Management API

Endpoint	Supported Methods	Description
Users	GET,PUT	Retrieve or update Sync Users.