Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetFileGroupsFromPublication

int ctMemphisGetFileGroupsFromPublication( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the FileGroups from the Replication Manager Database for the given Publication.

HTTP URL: <baseURL>/ctMemphisGetFileGroupsFromPublication/

HTTP Verb: POST

Constraints:

  • "id" must be an existing Publication ID.

Parameters:

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

{

"id": 0, // required - 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:

{

"fileGroupList": [

{

"id": 1,

"dbEngine": 0,

"name": "fileGroup1",

"description": "File group for ABC purposes"

},

{

"id": 2,

"dbEngine": 0,

"name": "fileGroup2",

"description": "File group for XYZ purposes"

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 2 // total number of publication file groups for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex