Method GetMultipleSubFolders
GetMultipleSubFolders(String, List<FolderPathContract>, FolderRetrieveOptionsContract)
Get multiple folders with sub folders for paths
Declaration
SubFoldersResultContract GetMultipleSubFolders(string connectionId, List<FolderPathContract> folderPaths, FolderRetrieveOptionsContract retrieveOptions)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
| System.Collections.Generic.List<FolderPathContract> | folderPaths | FolderPaths to retrieve |
| FolderRetrieveOptionsContract | retrieveOptions | Optional: The folder retrieve options. See also FolderRetrieveOptionsContract |
Returns
| Type | Description |
|---|---|
| SubFoldersResultContract | Multiple folders with sub folders |
Examples
POST http://YourServerName/InfoShare/Json/Folder/GetMultipleSubFolders
Example that gets multiple folders with sub folders for specific paths.{
"connectionId": "23a97160-3a3d-4acf-bb93-8040848440f4",
"folderPaths": [
{
"Path": "48671d92-ec12-11db-8fe2-005056c00008\\77faef6f-ec52-11db-8fe4-005056c00008",
"FolderSystemId": "48671d6c-ec12-11db-8fe2-005056c00008"
},
{
"FolderSystemId": "48671d6c-ec12-11db-8fe2-005056c00008",
"Path": "48671d92-ec12-11db-8fe2-005056c00008\\8ca04d9e-96da-11dc-a2df-000c292edb85"
}],
"retrieveOptions": {
"RetrieveDocuments": false }
}Response:
{
"GetMultipleSubFoldersResult": {
"ServiceExceptions": [],
"SubFolders": [
{
"AccessRightsEnum": [
"View",
"SetSecurity",
"EditProperties",
"EditFolder",
"CreateQuery",
"SetMasterColumnConfiguration",
"CreateFolder",
"CreateQuery",
"Delete"
],
"ColumnConfiguration": {
"Columns": [
{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2
},
{
"PropertyTypeId": "01004001-38a7-11d8-a902-0050bf427e8f",
"Width": -2
}
],
"GroupedColumnIds": [],
"InheritProperties": false,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false,
"SortedColumns": []
},
"ColumnConfigurationResolved": {
"Columns": [
{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2
},
{
"PropertyTypeId": "01004001-38a7-11d8-a902-0050bf427e8f",
"Width": -2
}
],
"GroupedColumnIds": [],
"InheritProperties": false,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false,
"SortedColumns": []
},
"Documents": null,
"HasDocuments": false,
"Id": "8ca04d9e-96da-11dc-a2df-000c292edb85",
"ImportTemplateId": null,
"Name": {
"Values": [
{
"Culture": "de",
"Text": "Vorlagen"
},
{
"Culture": "de-CH",
"Text": "Vorlagen"
}
]
},
"Path": {
"Culture": "en-US",
"FolderSystemId": "48671d6c-ec12-11db-8fe2-005056c00008",
"Path": "48671d92-ec12-11db-8fe2-005056c00008\\8ca04d9e-96da-11dc-a2df-000c292edb85",
"PathGlobal": {
"Values": [
{
"Culture": "de",
"Text": "Vorlagen"
},
{
"Culture": "de-CH",
"Text": "Vorlagen"
}
]
}
},
"Processes": null,
"Properties": [
{
"GlobalValues": [],
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Values": [
"Vorlagen"
]
},
{
"GlobalValues": [
{
"Values": [
{
"Culture": "en",
"Text": "Default Security"
},
{
"Culture": "de",
"Text": "Standard Sicherheit"
},
{
"Culture": "fr",
"Text": "Standard Sicherheit"
}
]
}
],
"PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
"Values": [
"0100a000-38a7-11d8-a902-0050bf427e8f"
]
}
],
"ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
"SearchFolders": [],
"SubFolders": []
}
]
}
} Exceptions
| Type | Condition |
|---|---|
| ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |
| ServiceException | Not allowed (10014) |
| ServiceException | Root folder not found (10023) |
| ServiceException | Folder not found {folderPath} (10025) |
| ServiceException | Property type not found {propertyTypeId} (10034) |
| ServiceException | Unknown data type for property type (10035) |
| ServiceException | Verification code is needed: Verification code not yet verified (10152) |