This command is for Files and Folders only. For Disk Image Standard, browse by volume.
Input Parameters
The following table provides the input parameters and descriptions.
Parameter | Description |
page | Optional parameter. If not specified, 50 items are fetched, beginning with index 0. Caution: This parameter should always be used unless there are fewer than 50 children beneath the browsed entity. startIndex - integer Determines index from which the page begins. count - integer Determines how many items are fetched beginning with startIndex. |
path | String. Path of the drive or folder to be browsed. |
sessionId | String. Containing a GUID of a previously obtained browsing session using the "Create Files and Folders Backup Set Browse session" API. |
Example:
{
"sessionId": "59c0c022-31c7-457e-9b00-69e6595d3bf9",
"page":{
"startIndex": 0,
"count": 100
},
"path": "c:\\"
}
Output Parameters
The following table provides the output parameters and descriptions.
Parameter | Description | ||||||
numberOfFiles | Long. Number of files directly underneath the folder. | ||||||
numberOfFolders | Long. Number of folders directly underneath the folder. | ||||||
selectable | Boolean. Shows whether the input path is selectable or not. | ||||||
unselectableReason | Integer. Shows the reason the drive could not be selected. If selectable = true, then unselectableReason is 0. The following values are possible:
| ||||||
hasChildren | Boolean. Shows whether the input path has any child folders or files. | ||||||
path | String. Shows the path of the parent folder. | ||||||
folders | Array. Shows with the following structure:
| ||||||
hasChildren | Boolean. Shows whether there are any children (files or folders) underneath the folder or drive. | ||||||
numberOfFiles | Long. Shows number of files on the first level of the folder or drive (directly underneath). | ||||||
numberOfFolders | Long. Shows number of folders in the first level of the folder or drive (directly underneath). | ||||||
selectable | Boolean. Shows whether the folder or drive is selectable for backup. | ||||||
unselectableReason | Integer. Shows the reason why the drive could not be selected. If selectable = true, then unselectableReason is 0. The following values are possible:
| ||||||
files | Array. Shows with following structure:
|
Example:
{
"numberOfFiles": 2,
"numberOfFolders": 4,
"selectable": true,
"unselectableReason": 0,
"hasChildren": true,
"path": "C:\\",
"folders": [
{
"numberOfFiles": 1,
"numberOfFolders": 1,
"selectable": true,
"unselectableReason": 0,
"hasChildren": true,
"name": "Program Files",
"path": "C:\\Program Files",
"state": 0
},
{
"numberOfFiles": 1,
"numberOfFolders": 1,
"selectable": true,
"unselectableReason": 0,
"hasChildren": true,
"name": "Program Files (x86)",
"path": "C:\\Program Files (x86)",
"state": 0
},
{
"numberOfFiles": 1,
"numberOfFolders": 1,
"selectable": true,
"unselectableReason": 0,
"hasChildren": true,
"name": "ProgramData",
"path": "C:\\ProgramData",
"state": 0
},
{
"numberOfFiles": 1,
"numberOfFolders": 1,
"selectable": true,
"unselectableReason": 0,
"hasChildren": true,
"name": "Windows",
"path": "C:\\Windows",
"state": 5
}
],
"files": [
{
"name": "test2.txt",
"path": "C:\\test2.txt",
"state": 0
},
{
"name": "todo.txt",
"path": "C:\\todo.txt",
"state": 0
}
]
}