REST API
Version 24.2.8980
Version 24.2.8980
REST API
CData Sync provides a REST API that complies with the OData 4.0 standard. With this API, you can use RESTful API calls to perform the same tasks that you do in the Sync administration console. For example, you can use the API to query configured connections, jobs, and job history. You can start or cancel jobs, as well.
To access the API, click the API tab from the menu bar of the Sync administration console.
The REST API page provides information about resources, actions, authentication, and supported formats. The left pane of the window contains an API reference section that details the API calls and provides JavaScript and cURL code examples.
Job Management API
Endpoint | Supported Methods | Description |
---|---|---|
Jobs | GET, POST, PUT, DELETE | Retrieves or updates the configuration for existing job or creates a new job. |
Transformations | GET, POST, PUT, DELETE | Retrieves or updates the configuration for existing transformations or creates a new transformation. |
Tasks | GET, POST, PUT, DELETE | Retrieves or updates the configuration for existing tasks of a job or adds a new task to a job. |
GetJobStatus | POST | Retrieves the status of all jobs or the status of each query within a specified job. |
ExecuteJob | POST | Starts the specified job. |
ExecuteQuery | POST | Executes a subset of queries within a job. You must specify both the job and the query. |
CancelJob | POST | Cancels a currently running job. |
History | GET | Retrieves the history of previous job runs. |
GetJobLog | POST | Retrieves logs from a previous job run or job runs. |
Connection Management API
Endpoint | Supported Methods | Description |
---|---|---|
Connections | GET, POST, PUT, DELETE | Retrieves or updates the configuration for existing connections or adds a new connection to the application. |
TestConnection | POST | Tests a previously created connection. |
GetConnectionTables | POST | Retrieves a list of tables for a connection. |
GetConnectionTableColumns | POST | Retrieves a list of columns for a table. |
User Management API
Endpoint | Supported Methods | Description |
---|---|---|
Users | GET, POST, PUT | Creates, retrieves, or updates Sync users. |
CreateUsers | POST | Creates multiple Sync users. |