Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetPublications

int ctMemphisGetPublications( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the Publications from a given search criteria from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisGetPublications/

HTTP Verb: POST

Parameters:

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

{

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

all the publications from all the DBEngines

"name": "publication1", // optional, if provided search file publication

by name

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

by name will look for like "<name>%"

"id": 1, // optional, if provided, search Publication 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

}

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

{

"publicationList": [

{

"id": 1,

"name": "publication1",

"description": "Publication for ABC purposes",

"dbEngine": 0,

"type": "file"

},

{

"id": 2,

"name": "publication2",

"description": "Publication for XYZ purposes",

"dbEngine": 1,

"type": "file"

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

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

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex