Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisFSLoadFolders

int ctMemphisFSLoadFolders( pRCESJson request, ppRCESJson result )

Description:

Scan all the folders under the given "rootTreePath". Populates the directories into the FileTable and also return the list of folders found.

HTTP URL: <baseURL>/ctMemphisFSLoadFolders/

HTTP Verb: POST

Parameters:

  • request [IN] - Filesystem scan for folder request in JSON format. For example:

{

"volume": 1, // required

"root": "FairCom" // optional, if not passed in, or passed NULL,

the root volume will assume, see

Note 3 - File Separators

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

{

"fileList": [

{

"id": 0,

"volume": 1,

"path": "FairCom",

"name": "V10.1.3",

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

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

},

{

"id": 0,

"volume": 1,

"path": "FairCom",

"name": "V10.1.4",

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

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

}

],

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

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

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex