Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisResyncFiles

int ctMemphisResyncFiles( pRCESJson request, ppRCESJson result )

Description:

Resync one or more replicated files.

As this can be a very long action (depending on the files size), this is an asynchronous call and ctMemphisCheckAction() should be called later to check the action status.

Internally we have two ways to execute it:

  • If Replication Plan is active, we use the agent resync feature with replication running in transparent way;
  • If Replication Plan is not active, we do the same that has been done during the deploy's file synchronization but only for the list of published file list provided. During this process, the Replication Plan changes to be "In Resync" status and no other Replication action can be executed. And while the Replication Plan is in this status no other action could be available.

HTTP URL: <baseURL>/ctMemphisResyncFiles/

HTTP Verb: POST

Constraints:

  • "id" must be an existing Replication Plan ID.
  • All "fileList/file" must be existing File IDs present on the given Replication Plan's publication.
  • There is a hard-coded file count of 100. If more than that is required, we should break in extra calls or consider a Replication Plan deploy to resync all the files.

Parameters:

  • request [IN] - Resync Files request in JSON format. For example:

{

"id": 0, // required, Replication Plan ID

"fileList": [

{"file": 0},

{"file": 3},

{"file": 63},

{"file": 834}

]

}

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

{

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"actionID":44135

}

Return:

Error code

TOCIndex