Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetRulesFromPublication

int ctMemphisGetRulesFromPublication( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the Rules for the given Publication "by File", "by Folder", and "by Database".

HTTP URL: <baseURL>/ctMemphisGetRulesFromPublication/

HTTP Verb: POST

Constraints:

  • "id" must be an existing Publication ID.

Parameters:

  • request [IN] - Get Publication files 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:

List of files/tables:

{

"fileList": [

{

"id": 0,

"volume": 1,

"path": "FairCom\\V10.1.3\\winX64\\bin\\ace\\sql\\data\\ctreeSQL.dbs",

"name": "test.dat",

"table": "test",

"size": 11736,

"createTime": "2014-04-07T13:18:09",

"updateTime": "2014-04-07T14:16:39",

"isDir": 0,

"isPartitioned": false,

"type": 6,

"database": 1,

"isReplicable": false,

"isCtree": true,

"description": "File is c-tree but doesn't have an index that qualifies for replication"

},

{

"id": 2,

"volume": 1,

"path": "FairCom\\V10.1.3\\winX64\\bin\\ace\\sql\\data\\ctreeSQL.dbs",

"name": "test2.dat",

"table": "test2",

"size": 125533,

"createTime": "2014-04-07T13:18:09",

"updateTime": "2014-04-07T14:16:39",

"isDir": 0,

"isPartitioned": false,

"type": 5,

"database": 1,

"isReplicable": false,

"isCtree": true,

"description": "File is c-tree but doesn't have an index that qualifies for replication"

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

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

see Note 1 - Paging Parameters

}

List of folders:

{

"folderRuleList": [

{

"id": 243,

"folderVolume": 1,

"folderPath": "FairCom\\data1",

"listType": "exclude",

"filenames": [

"customer.dat",

"product.dat"

],

"filenameWildcards": [

"tmp*",

"*.tmp"

],

"filenameRegex": [

"[^abc]",

"(def*|*.cfg)"

]

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

List of Dictionary rules:

{

"dictionaryRuleList": [

{

"database": 27499,

"databaseName": "ctreeSQL.dbs",

"dictionaryFileName": "c:/server2/databases/database1/SQL_SYS/database1.fdd"

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

List of Folder and Dictionaries rules:

{

"dictionaryRuleList": [

{

"database": 27499,

"databaseName": "ctreeSQL.dbs",

"dictionaryFileName": "c:/server2/databases/database1/SQL_SYS/database1.fdd"

}

],

"folderRuleList": [

{

"id": 243,

"folderVolume": 1,

"folderPath": "FairCom\\data1",

"listType": "exclude",

"filenames": [

"customer.dat",

"product.dat"

],

"filenameWildcards": [

"tmp*",

"*.tmp"

],

"filenameRegex": [

"[^abc]",

"(def*|*.cfg)"

]

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}

}

Return:

Error code

TOCIndex