Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetSubscriptions

int ctMemphisGetSubscriptions( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the Subscriptions by a given DBEngine or by a given Replication Plan or by a given Publication from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisGetSubscriptions/

HTTP Verb: POST

Parameters:

  • request [IN] - Get Subscriptions request in JSON format. For example:

{

"dbEngine": 0, // optional, if not passed, it will return all the

subscriptions from all the DBEngines

"replPlan": 0, // optional, if not passed, it will return all the

subscriptions from all the Replication Plans

"name": "subscription1", // optional, if provided with also the dbEngine or

replPlan, search subscription by name

"partial": true, // optional, if provided with "name", the search by

name will look for like "<name>%"

"id": 1, // optional, if provided, search Subscription by ID

"publication": 0, // optional, if provided, search all the

subscriptions for a given Publication ID

"paging": true, // optional, see Note 1 - Paging Parameters

"limit": 100, // optional, see Note 1 - Paging Parameters

"start": 200 // optional, see Note 1 - Paging Parameters

}

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

{

"subscriptionList": [

{

"id": 1,

"name": "subscription1",

"description": "Subscription for ABC purposes",

"publication": 0,

"dbEngine": 0,

"redirectionList": [

{

"sourcePath": "C:\sourcePath1",

"targetPath": "C:\targetPath1"

},

{

"sourcePath": "C:\sourcePath2",

"targetPath": "C:\targetPath2"

}

]

},

{

"id": 2,

"name": "subscription2",

"description": "Subscription for XYZ purposes",

"publication": 1,

"dbEngine": 1,

"redirectionList": [

]

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 2 // total number of Subscriptions for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex