REST API V1
Version 26.1.9516
Version 26.1.9516
REST API V1
CData Sync provides two REST API versions that you can use to automate and integrate with Sync:
-
Sync API V2—The latest, fully REST-based API with a redesigned resource model.
-
Sync API V1—The original OData-style API.
Both of these APIs are fully supported.
Sync API V2
Sync API V2 introduces a modern, resource-oriented REST architecture and a new object model that aligns with the current Sync UI and internal platform design.
Features for API V2 include the following:
-
Versioned base paths with the API version embedded in the endpoint URL (for example,
/api.rsc/v2/...) -
Resource-based URLs for entities such as workspaces, jobs, connections, pipelines, and events
-
Standard REST verbs (GET, POST, PUT, DELETE) instead of function-style endpoints
-
Identifier-based addressing using system-generated identifiers rather than name-based or OData key
-
Richer JSON response models with nested objects and structured collections instead of flat OData feeds.
This API is composed of seven separate APIs:
Sync API V1
Sync API V1 is the original REST API and follows an OData-style design. This API exposes operations primarily through function-style endpoints such as the following examples:
-
/api.rsc/executeJob -
/api.rsc/getJobs -
api.rsc/getTables
This API uses name-based keys and OData conventions for filtering, querying, and navigation.
This API is composed of three separate APIs: