Replication WebAPI

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

Replication params

Salesforce Params

Database Params

Table Params

Log Properties params

Run Properties Params

Below table gives the attribute list of the response class

Example

Curl

Request URL

Response Body

Response Code

Response Headers

/checkStatus

The Check status method is used to return the status of the replication process and to invoke this method user must have the process id attribute . The process id can be generated from the first method "Replicate", the check status method has two parts to it one is the request object and the other is the response object.

The below table explains the attributes and their description of this method. The process ID is the mandatory attribute used to invoke this call.