Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetDatabases

int ctMemphisGetDatabases( pRCESJson request, ppRCESJson result )

Description:

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

HTTP URL: <baseURL>/ctMemphisGetDatabases/

HTTP Verb: POST

Parameters:

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

{

"id": 0, // optional, if passed, search by

the database identification

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

all the databases from all the dbEngines

"name": "database1", // optional, if passed, with the dbEngine,

search for a specific database by name

"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 databases from the Replication Manager Database.

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

{

"databaseList": [

{

"id": 1,

"dbEngine": 0,

"name": "database1",

"dictFileName": "c:\server\databases\database1\SQL_SYS\database1.fdd",

"isSQL": true

},

{

"id": 1,

"dbEngine": 0,

"name": "database2",

"dictFileName": "c:\server\databases\database2\database2.fdd",

"isSQL": false

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 500 // total number of databases for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex