Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisSubsFilesPreview

int ctMemphisSubsFilesPreview( pRCESJson request, ppRCESJson result )

Description:

Build a list of target files for the given Publication and Subscription setup in a preview mode.

HTTP URL: <baseURL>/ctMemphisSubsFilesPreview/

HTTP Verb: POST

Constraints:

  • "publication": must be an existing Publication ID.
  • "dbEngine": must be an existing DBEngine ID.
  • "database": if provided must be an existing database ID that is owned by the "dbEngine".

Parameters:

  • request [IN] - Get Subscription files preview request in JSON format. For example:

{

"publication": 0, // required - Publication ID

"dbEngine": 1, // required - Subscription's DBEngine identification

"redirectionList": [ // optional - if not provided assumes no redirection

{

"sourcePath": "C:\sourcePath1",

"targetPath": "C:\targetPath1"

},

{

"sourcePath": "C:\sourcePath2",

"targetPath": "C:\targetPath2"

}

],

"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:

{

"fileListPreview": [

{

"volume": 1,

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

"name": "test.dat",

"type": 6,

"isDir": false,

"isPartitioned": false,

"isReplicable": false,

"isCtree": true,

"description": "Check pending"

},

{

"volume": 1,

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

"name": "test2.dat",

"type": 5,

"isDir": false,

"isPartitioned": false,

"isReplicable": false,

"isCtree": true,

"description": "File is c-tree but doesn't have an index

that qualifies for replication"

},

{

"volume": 1,

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

"name": "tempFile1.dat",

"type": 5,

"isDir": false,

"isPartitioned": false,

"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": 3 // total number of publication files for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex