Browse Folders and Drives API

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:

0 (none) - means the folder or drive is selectable
1 (LocalVaultPath) - means the folder or drive is not selectable because it contains the local vault, which must not be selected for back up.
2 (CompressedOrEncryptedFolder) - means that the drive contains encrypted or compressed folders and cannot be selected directly.
3 (UnsupportedFileSystem) - means the drive is not selectable because the file system is not supported.

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:

name

String. Name of the folder or drive.

path

String. Path of the folder or drive.

state

Integer. Shows the state of the selection. Depending on the state, the item may not be selectable. The following values are possible:

0 (Unselected) - this is the default, means the folder or drive is selected.

1 (Selected) - not used but mentioned here for completeness.

2 (Mixed) - not used but mentioned here for completeness.

3 (Disabled) - not used but mentioned here for completeness.

4 (InLocalBackup) - shows that the path is included in another local-only backup set. Hence, it cannot be included in the current backup set if the destination is Cloud (Online) or Cloud and Local.

5 (GloballyExcluded) - folder or drive is part of a Global exclusion rule and cannot be selected for backup

8 (Destination) - not used but mentioned here for completeness.

9 (DisabledFull) - not used but mentioned here for completeness.

11 (Excluded) - folder or drive is part of an exclusion rule and cannot be selected for backup.

12 (InRemoteBackup) - shows that the path is included in another Cloud or Cloud and Local Vault backup set. Hence, it cannot be included in the current backup set if the destination is Local Only.

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:

0 (none) - means the folder or drive is selectable.
1 (LocalVaultPath) - means the folder or drive is not selectable because it contains the local vault, which must not be selected for back up.
2 (CompressedOrEncryptedFolder) - means that the drive contains encrypted or compressed folders and cannot be selected directly.
3 (UnsupportedFileSystem) - means the drive is not selectable because the file system is not supported.

files

Array. Shows with following structure:

name	String. Name of the file.
state	Integer with the same possible values as described above for folders.state.
path	String. Path of the file.

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

}

]

}