2022
REST API
The REST API provides programmatic access to Reading and Write replication data. The REST API identifies the replication application and its users using OAUTH ; responses are available in json. We have used SWAGGER editor for the end users to make the API calls so that they can try out APIs exposed by our platform.
The link for accessing the API docs is http://localhost:8080/webapi/api-docs/repl-v4/ReplicationAPIDriver
Checklist Before Getting Started
- User should have the release of 4.6.1 or later.
- The on-premise instance should have Replication service running.
There is two API Methods list which is exposed for this release, we will be adding more methods in the upcoming releases. The order of the execution of API calls are as follows
- Replicate
- checkStatus
/replicate
The Replicate method is the actual API call used to invoke the replication process so that the Salesforce objects gets replicated to the Database. From this call, the process id is generated which is used in the checkStatus method to check the status of the replication process.
The below tables explains the various model schema and attributes which form the model class
Parameter | Description | DataType |
Salesforce (optional) | The salesforce credentials which are required to connect to the Salesforce instance | Salesforce |
Database (optional) | The database credentials which are required to connect to supported databases | Database |
Objects (optional) | The salesforce object which a client to replicate | Array Table |
Logs (optional) | The parameters related to Log settings and specific to DBSync | Log properties |
Run (optional) | The parameters related to run settings and specific to DBSync | Run properties |
Overview
Content Tools