Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetLayouts

int ctMemphisGetLayouts( pRCESJson request, ppRCESJson result )

Description:

Retrieve a list of Layouts from the Replication Manager Database

HTTP URL: <baseURL>/ctMemphisGetLayouts/

HTTP Verb: POST

Parameters:

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

{

"layoutId": 0, // optional, if not passed, it will return the layouts 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:

{

"layoutList": [

{

"id": 1,

"objectType: 1, // 1 for Group - 2 for dbEngines

"objectId": 2,

"posX": 100,

"posY": 200,

"height": 100,

"width": 200,

"collapsed": true

},

{

"id": 2,

"objectType: 2, // 1 for Group - 2 for dbEngines

"objectId": 3,

"posX": 100,

"posY": 200,

"height": 100,

"width": 200,

"collapsed": false

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

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

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex