Web API

DBSync Cloud Replication can run replication process using Web API thus allowing usage of Web Service call to initiate the process of replication. This section explains the steps involved in running the replication using Web API.

The URL should be passed to run the replication using Web API. When the URL is passed, if any replication process is already running, the status will show as running. If no other process is running, the status will show as submitted which actually initiates replication process depending on the URL.
URL should be in the below format.

http://localhost:8080/dbsync/profile/run/<<profile-name>>/<<run-type>>?retType=json

<<profile-name>> is the name of the profile
<<run-type>> decides the type of replication process and it can be cleancopy, sf_to_db or db_to_sf

• cleancopy
  • to run clean copy from Salesforce to Database
• sf_to_db
  • to run incremental sync from Salesforce to Database
• db_to_sf
  • to run Database to Salesforce replication

Example:

• To run cleancopy from profile sqlserver
  • http://localhost:8080/dbsync/profile/run/sqlserver/cleancopy?retType=json

• To run incremental replication from profile sqlserver
  • http://localhost:8080/dbsync/profile/run/sqlserver/sf_to_db?retType=json

• To run Database to Salesforce Replication from profile sqlserver
  • http://localhost:8080/dbsync/profile/run/sqlserver/db_to_sf?retType=json