Method GetFolder
GetFolder(String, FolderPathContract)
Get folder for path
Declaration
FolderContract GetFolder(string connectionId, FolderPathContract folderPath)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | connectionId |
|
| FolderPathContract | folderPath | FolderPath to retrieve |
Returns
| Type | Description |
|---|---|
| FolderContract | Folder |
Examples
POST http://YourServerName/InfoShare/Json/Folder/GetFolder
Example for return folder for specific path.{
"connectionId":"23a97160-3a3d-4acf-bb93-8040848440f4",
"folderPath":{
"Path":"cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08"}
}Response:
{
"GetFolderResult": {
"AccessRightsEnum": ["SetSecurity", "Delete", "EditProperties", "EditFolder",
"SetMasterColumnConfiguration", "CreateQuery", "CreateFolder"],
"ColumnConfiguration": {
"Columns": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2 }],
"GroupedColumnIds": [],
"InheritProperties": true,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false,
"SortedColumns": [] },
"ColumnConfigurationResolved": {
"Columns": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Width": -2 }],
"GroupedColumnIds": [],
"InheritProperties": false,
"ShowAggregateFunctions": false,
"ShowColumnFilters": false,
"ShowGroupsExpanded": false,
"SortedColumns": [] },
"Documents": [],
"HasDocuments": false,
"Id": "400c1f61-c0cf-e911-a939-00155d290a08",
"ImportTemplateId": null,
"Name": {
"Values": [{
"Culture": "de",
"Text": "Allgemeine Suche" }, {
"Culture": "en",
"Text": "Default search" }] },
"Path": {
"Culture": "en-US",
"FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
"Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08",
"PathGlobal": {
"Values": [{
"Culture": "de",
"Text": "Allgemeine Suche" }, {
"Culture": "en",
"Text": "Default search" }] } },
"Processes": [],
"Properties": [{
"PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
"Values": ["Default search"] }, {
"PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
"Values": ["0100a000-38a7-11d8-a902-0050bf427e8f"] }],
"ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
"SearchFolders": [{
"Id": "7d4006c1-c0cf-e911-a939-00155d290a08",
"Name": {
"Values": [{
"Culture": "de",
"Text": "Komplexe suche" }, {
"Culture": "en",
"Text": "Complexe search" }] },
"ObjectTypeEnum": "Query",
"Path": {
"Culture": "en-US",
"FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
"Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08
\\7d4006c1-c0cf-e911-a939-00155d290a08",
"PathGlobal": {
"Values": [{
"Culture": "de",
"Text": "Allgemeine Suche\\Komplexe suche" }, {
"Culture": "en",
"Text": "Default search\\Complexe search" }] } } } ],
"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) |