Method GetSearchFolder

GetSearchFolder(String, FolderPathContract)

Get search folder for path

Declaration

SearchFolderContract GetSearchFolder(string connectionId, FolderPathContract folderPath)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
FolderPathContract	folderPath	FolderPath to retrieve

Returns

Type	Description
SearchFolderContract	SearchFolder

Examples

POST http://YourServerName/InfoShare/Json/Folder/GetSearchFolder

Example get search folder for specific path.

{
   "connectionId": "23a97160-3a3d-4acf-bb93-8040848440f4",
   "folderPath": {
     "FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
     "Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08 
            \\50b9cb06-c1cf-e911-a939-00155d290a08" }
}

Response:

{ 
   "GetSearchFolderResult": {
     "AccessRightsEnum": ["SetSecurity", "Delete", "SetMasterColumnConfiguration", "EditQuery"],
     "ColumnConfiguration": {
       "Columns": [{
         "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
         "Width": -2 }, {
         "PropertyTypeId": "01000004-d596-485b-ace6-d64647a94277",
         "Width": -2 }, {
         "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
         "Width": -2 }, {
         "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
         "Width": -2 }, {
         "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
         "Width": -2 }, {
         "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
         "Width": -2 }],
       "GroupedColumnIds": ["2cdacc4e-15d0-e911-a93a-00155d290a08", "01000004-d596-485b-ace6-d64647a94277"],
       "InheritProperties": false,
       "ShowAggregateFunctions": false,
       "ShowColumnFilters": false,
       "ShowGroupsExpanded": false,
       "SortedColumns": [{
         "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
         "SortOrderEnum": "Ascending" }, {
         "PropertyTypeId": "01000004-d596-485b-ace6-d64647a94277",
         "SortOrderEnum": "Ascending" }] },
     "ColumnConfigurationResolved": {
       "Columns": [{
          "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
          "Width": -2 }, {
          "PropertyTypeId": "01000004-d596-485b-ace6-d64647a94277",
          "Width": -2 }, {
          "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
          "Width": -2 }, {
          "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
          "Width": -2 }, {
          "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
          "Width": -2 }, {
          "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
          "Width": -2 }],
        "GroupedColumnIds": ["2cdacc4e-15d0-e911-a93a-00155d290a08", "01000004-d596-485b-ace6-d64647a94277"],
        "InheritProperties": false,
        "ShowAggregateFunctions": false,
        "ShowColumnFilters": false,
        "ShowGroupsExpanded": false,
        "SortedColumns": [{
          "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
          "SortOrderEnum": "Ascending" }, {
          "PropertyTypeId": "01000004-d596-485b-ace6-d64647a94277",
          "SortOrderEnum": "Ascending" }] },
     "Description": {
       "Values": [{
         "Culture": "de",
         "Text": "Einfache suche" }, {
         "Culture": "en",
         "Text": "Simple search" }] },
     "FulltextSearchVisible": false,
     "Id": "50b9cb06-c1cf-e911-a939-00155d290a08",
     "IsSimpleSearch": true,
     "Name": {
       "Values": [{
         "Culture": "de",
         "Text": "Einfache suche" }, {
         "Culture": "en",
         "Text": "Simple search" }] },
     "Path": {
       "FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
       "Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08
              \\50b9cb06-c1cf-e911-a939-00155d290a08",
       "PathGlobal": {
         "Values": [{
           "Culture": "de",
           "Text": "Allgemeine Suche\\Einfache suche" }, {
           "Culture": "en",
           "Text": "Default search\\Simple search" }] } },
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "SearchConditionConfiguration": [{
     "DisplayText": {
       "Values": [{
       "Culture": "de",
       "Text": "Letztes Einbuchen" }, {
       "Culture": "fr",
       "Text": "Dernier déverrouillage" }, {
       "Culture": "en",
       "Text": "Last check in" }] },
     "Editable": true,
     "PlaceHolder": "",
     "PropertyTypeId": "01000009-38a7-11d8-a902-0050bf427e8f",
     "Visible": true }],
     "SearchDefinition": {
       "Conditions": [{
         "ComparisonEnum": "LessEquals",
         "Id": "5f57aed3-54d2-e911-a93d-00155d290a08",
         "PlaceHolder": "%currentdatetime%",
         "PropertyTypeId": "01000009-38a7-11d8-a902-0050bf427e8f",
         "RelationEnum": "And",
         "Values": [] }],
       "FulltextWordRelation": "AND",
       "FulltextWords": "",
       "PageSize": 100,
       "SearchStores": ["4b07ac1e-b9cf-e911-a939-00155d290a08", "c5b7dd4e-b8cf-e911-a939-00155d290a08",
          "5ff3c8f6-b8cf-e911-a939-00155d290a08", "3bb6448c-b9cf-e911-a939-00155d290a08",
          "67727470-b9cf-e911-a939-00155d290a08", "e46bc061-b7cf-e911-a939-00155d290a08"],
       "UseWildCard": true },
     "StoreSelectionVisible": true }
}

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	Search folder not found {searchFolderPath} (10024)
ServiceException	Unknown data type for property type (10035)
ServiceException	Verification code is needed: Verification code not yet verified (10152)