Page History

...

Parameter	Description	DataType
emailerror (optional)	The possible values are true and false to enable them and disable the email notification from DBSync replication tool	boolean
database (optional)	The possible values are true and false to enable them and disable the email notification of database from DBSync replication tool	boolean
dir (optional)	The directory name if the database if flat file database	string
emailreceipents (optional)	The email id of the recipient to who the system is intended to send out the logs / notifications	Array[string]
emailsender (optional)	The email id of the sender can be also be passed to identify the from address	string
callbackURL (optional)	The DBSync URL which sends the email notifications	string

Run Properties Params

Parameter	Description	DataType
command (optional)	The commands which are internal to DBSync replication like Cleancopy, DBtoSF, SFtoDB,db_setup	string
Profile (optional)	The profile name which user used in DBSync replication tool	string

Below table gives the attribute list of the response class

*Parameter*	*Description*	*Data type*
Status	The possible values are True and False which sends out the response value	String
SubmitTime	The API submitted time	Date
CompletionTime	The API Completion Time	Date
ProcessID	The process id which is sent by the API to identify the process	String
callbackURL	The URL is passed from the API	string

Example

Curl

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"salesforce":{"soapEndpoint":"https://login.salesforce.com/services/Soap/u/32.0","bulkApiEnable":false,"callbackUrl":"https://localhost:8443/DBSync/oauth/_callback","consumerKey":"","consumerSecret":"3Q/190VEz3BnIu6bMGO2sg\\\\=\\\\=","password":"avankia!23","username":"ravindra.g@avankia.com"},"database":{"fileReplication":false,"fileVersion":false,"s3":false,"awsAccessKey":"","awsBucketName":"","awsRegion":"","consumerSecret":"","database":"ORCL","filepath":"","host":"10.0.0.9","password":"Avankia1","port":"1521","schema":"dbsync","type":"Oracle","url":"jdbc:oracle:thin:@10.0.0.9:1521:ORCL","username":"HR"},"objects":[{"excludes":[],"filter":"","name":"Account"}],"log":{"emailError":false,"database":true,"dir":"","emailRecipients":["ravindra.g@avankia.com"],"emailSender":"ravindra.g@avankia.com","callbackURL":"http://posttestserver.com/post.php"},"run":{"command":"cleancopy","profile":""}}' 'http://localhost:8080/webapi/appcode/repl-v4/ReplicationAPIDriver/replicate'

Request URL

http://localhost:8080/webapi/appcode/repl-v4/ReplicationAPIDriver/replicate

Response Body

{

"value": [

{

"status": "submitted",

"submitTime": "2016-04-21T19:31:37Z",

"processId": "ravindra.g@avankia.com-1461267097548/cleancopy",

"callbackURL": "http://posttestserver.com/post.php"

}

]

}

Response Code

h6. 200

Response Headers

{

"date": "Thu, 21 Apr 2016 19:31:37 GMT",

"server": "Apache-Coyote/1.1",

"content-length": "182",

"content-type": "application/json"

}

/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.

*Parameter*	*Description*	*Data type*
Status	The possible values are True and False which sends out the response value	String
SubmitTime	The API submitted time	Date
CompletionTime	The API Completion Time	Date
ProcessID	The process id which is sent by the API to identify the process	String
callbackURL	The URL is passed from the API	string

Example

Curl

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"processId":"ravindra.g@avankia.com-1461267097548/cleancopy"}' 'http://localhost:8080/webapi/appcode/repl-v4/ReplicationAPIDriver/checkStatus'

Request URL

http://localhost:8080/webapi/appcode/repl-v4/ReplicationAPIDriver/checkStatus

Response Body

{

"value": [

{

"status": "completed",

"submitTime": "2016-04-21T19:31:37Z",

"completionTime": "2016-04-21T19:31:38Z",

"processId": "ravindra.g@avankia.com-1461267097548/cleancopy",

"callbackURL": "http://posttestserver.com/post.php",

"errorMessage": [

null

]

}

]

}

Response Code

200

Response Headers

{

"date": "Thu, 21 Apr 2016 19:34:36 GMT",

"server": "Apache-Coyote/1.1",

"content-length": "244",

"content-type": "application/json"

}

Page tree

Versions Compared

Old Version 7

New Version Current

Key