Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetFileGroups

int ctMemphisGetFileGroups( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the File Groups for a given DBEngine from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisGetFileGroups/

HTTP Verb: POST

Parameters:

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

{

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

return all the file groups from all

the dbengines

"name": "fileGroup1", // optional, if provided with also the

dbEngine, search file group by name

"id": 1, // optional, if provided, search file

group by 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

}

Note: If "dbEngine" is not provided, it will return all the file groups from the Replication Manager Database.

  • 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 file groups for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex