Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisDeployReplPlan

int ctMemphisDeployReplPlan( pRCESJson request, ppRCESJson result )

Description:

Deploy a Replication Plan. For each "Subscription", it syncs the target files and start replicating.

During the subscription deployment, the SubscriptionFile table is populated with all the file relationships (source and target) based on the publication files/file groups. Note that if a file or file group has been removed/updated, the subscription must be re-deployed in order to relink the source and target files.

HTTP URL: <baseURL>/ctMemphisDeployReplPlan/

HTTP Verb: POST

Parameters:

  • request [IN] - Deploy Replication Plan request in JSON format. For example:

{

"id": 0,

"forceReplace": true // Optional, default is FALSE. In case of FALSE, return

error 9053 (RCES_TARFIL_ERR) in case at least one of

the target files already exist and a list with

existing file names is returned in the message.

In case of TRUE, force replacing all the existing

target files.

}

  • result [OUT] - Result in JSON format. For example:

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"actionID":44135 // Action ID might not be returned in case no action

was generated, like if error or warning

}

Return:

Error code

TOCIndex