Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisImportReplAgent

int ctMemphisImportReplAgent( pRCESJson request, ppRCESJson result )

Description:

Import a list of Replication Agent setups into Replication Studio.

HTTP URL: <baseURL>/ctMemphisImportReplAgent/

HTTP Verb: POST

Constraints:

  • "opSystem" + "path" must be a valid Replication Agent installation directory.

Parameters:

  • request [IN] - Import Replication Agent request in JSON format. For example:

{

"simpleMode": true, // optional, if not passed,

assumed false

"replAgentList": [

{

"opSystem": 0, // required, Operating System in

which the Replication Agent

is installed

"path": "C:\faircom\v11.3.0\win32\tools", // required, Replication Agent

absolute full installation path

"replPlan": // optional, if not passed, all

the default values will be used

{

"name": "PLAN2", // optional, if not passed the

next available default name will

be picked

"description": "Plan 2 description" // optional

},

"publication": // optional, if not passed, all the

default values will be used

{

"id": 0, // optional, only passed if the

import should use an existing

Publication

"name": "publication3", // optional, if not passed the

next available default name

will be picked

"description": "General publication" // optional

},

"subscription": // optional, if not passed, all the

default values will be used

{

"name": "subscription3", // optional, if not passed the next

available default name will be picked

"description": "General subscription" // optional

}

},

{

"opSystem": 1,

"path": "C:\faircom\v11.3.0\win32\tools"

},

{

"opSystem": 2,

"path": "C:\faircom\v11.3.0\win32\tools"

},

]

}

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

{

"replAgentList": [

{

"opSystem": 0,

"path": "C:\faircom\v11.3.0\win32\tools"

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

},

{

"opSystem": 1,

"path": "C:\faircom\v11.3.0\win32\tools"

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

},

{

"opSystem": 2,

"path": "C:\faircom\v11.3.0\win32\tools"

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex