Method CreateSearchFolder

CreateSearchFolder(String, SearchFolderContract)

Create a search folder

Declaration

SearchFolderContract CreateSearchFolder(string connectionId, SearchFolderContract searchFolder)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
SearchFolderContract	searchFolder	SearchFolder to create.

Returns

Type	Description
SearchFolderContract	The created search folder id

Examples

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

Example for create a search folder.

{
   "connectionId": "23a97160-3a3d-4acf-bb93-8040848440f4",
     "searchFolder": {
       "SearchConditionConfiguration": [{
         "DisplayText": {
           "Values": [{
             "Culture": "de",
             "Text": "Sicherheitsbereich" }, {
             "Culture": "de-CH",
             "Text": "Sicherheitsbereich" }, {
             "Culture": "en",
             "Text": "Security domain" }, {
             "Culture": "en-US",
             "Text": "Security domain" }, {
             "Culture": "fr",
             "Text": "Étendue de sécurité" }] },
         "Editable": false,
         "PlaceHolder": "",
         "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
         "Visible": false,
         "TranslatedName": "Sicherheitsbereich",
         "Index": 0 }],
       "ColumnConfiguration": {
         "Columns": [{
           "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
           "Width": -2 }],
         "GroupedColumnIds": [],
         "SortedColumns": [],
         "InheritProperties": false,
         "ShowAggregateFunctions": false,
         "ShowColumnFilters": false,
         "ShowGroupsExpanded": false },
       "ColumnConfigurationResolved": {
         "Columns": [],
         "GroupedColumnIds": [],
         "SortedColumns": [],
         "InheritProperties": false,
         "ShowAggregateFunctions": false,
         "ShowColumnFilters": false,
         "ShowGroupsExpanded": false },
       "Description": {
         "Values": [{
           "Text": "testSearchfolder",
           "Culture": "de" }] },
       "FulltextSearchVisible": false,
       "IsSimpleSearch": false,
       "Name": {
         "Values": [{
           "Text": "testSearchfolder",
             "Culture": "de" }] },
       "SearchDefinition": {
         "SearchStores": ["4b07ac1e-b9cf-e911-a939-00155d290a08", "c5b7dd4e-b8cf-e911-a939-00155d290a08", 
         "eb299c1d-8bd0-e911-a93a-00155d290a08", "5ff3c8f6-b8cf-e911-a939-00155d290a08", 
         "3bb6448c-b9cf-e911-a939-00155d290a08", "67727470-b9cf-e911-a939-00155d290a08", 
         "e46bc061-b7cf-e911-a939-00155d290a08"],
         "Conditions": [{
           "Values": [""],
           "ComparisonEnum": "Equals",
           "PlaceHolder": "",
           "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
           "RelationEnum": "And" }],
         "FulltextWordRelation": "AND",
         "FulltextWords": "",
         "PageSize": 100,
         "UseWildCard": false },
       "StoreSelectionVisible": false,
       "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
       "Path": {
         "FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
         "Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08
                \\4e884c48-a7de-e911-a948-00155d290a08" } }
}

Response:

{
   "CreateSearchFolderResult": {
     "AccessRightsEnum": ["SetSecurity", "Delete", "SetMasterColumnConfiguration", "EditQuery"],
       "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": [] },
       "Description": {
         "Values": [{
           "Culture": "de",
           "Text": "testSearchfolder" }] },
       "FulltextSearchVisible": false,
       "Id": "66ee4a16-b6de-e911-a948-00155d290a08",
       "IsSimpleSearch": false,
       "Name": {
         "Values": [{
           "Culture": "de",
           "Text": "testSearchfolder" }] },
       "Path": {
         "Culture": "en-US",
         "FolderSystemId": "9762c061-b7cf-e911-a939-00155d290a08",
         "Path": "cb62c061-b7cf-e911-a939-00155d290a08\\400c1f61-c0cf-e911-a939-00155d290a08
                \\4e884c48-a7de-e911-a948-00155d290a08\\66ee4a16-b6de-e911-a948-00155d290a08",
         "PathGlobal": {
           "Values": [{
             "Culture": "de",
             "Text": "Allgemeine Suche\\testFolder\\testSearchfolder" }, {
             "Culture": "en",
             "Text": "Default search\\testFolder\\testSearchfolder" }] } },
       "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
       "SearchConditionConfiguration": [],
       "SearchDefinition": {
         "Conditions": [{
           "ComparisonEnum": "Equals",
            "Id": "9eee4a16-b6de-e911-a948-00155d290a08",
            "PlaceHolder": "",
            "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
            "RelationEnum": "And",
            "Values": [] }],
         "FulltextWordRelation": "AND",
         "FulltextWords": "",
         "PageSize": 100,
         "SearchStores": ["4b07ac1e-b9cf-e911-a939-00155d290a08", "c5b7dd4e-b8cf-e911-a939-00155d290a08", 
         "eb299c1d-8bd0-e911-a93a-00155d290a08", "5ff3c8f6-b8cf-e911-a939-00155d290a08", 
         "3bb6448c-b9cf-e911-a939-00155d290a08", "67727470-b9cf-e911-a939-00155d290a08",
         "e46bc061-b7cf-e911-a939-00155d290a08"],
         "UseWildCard": false },
       "StoreSelectionVisible": false
   }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Root folder not found (10023)
ServiceException	Folder not found {folderPath} (10025)
ServiceException	Search store not found {infoStore} (10033)
ServiceException	Property type not found {propertyTypeId} (10034)
ServiceException	Unknown data type for property type (10035)
ServiceException	String was not recognized as a valid DateTime: {dateTimeValue}. Expected format {expectedFormat} (10059)
ServiceException	Name is not unique for culture ({culture}): {name} (10066)
ServiceException	Object with id {id} already exists (10078)
ServiceException	Search conditions and condition configuration do not match (10079)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Not allowed (10014)