POST api/FacetedSearch/Find
Request Information
URI Parameters
None.
Body Parameters
KendoGridFilterDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Take | integer |
None. |
|
| Skip | integer |
None. |
|
| Page | integer |
None. |
|
| Filter | KendoGridFilterSetDto |
None. |
|
| Sort | Collection of KendoGridSortDto |
None. |
|
| AdditionalColumnDetails | Collection of KendoGridAdditionalColumnDetails |
None. |
|
| FacetedFilters | Collection of FacetedSearchFilterDto |
None. |
|
| AdditionalFilters | Collection of KendoGridFilterAdditionalFiltersDto |
None. |
|
| FacetedSearchResultFilters | Collection of FacetedSearchResultFilterDto |
None. |
|
| PivotableInfo | KendoGridFacetedSearchPivotableInfoDto |
None. |
|
| UseFacetedSearchAdvancedFilters | boolean |
None. |
|
| ShowClientOnly | boolean |
None. |
|
| IncludeIds | Collection of integer |
None. |
|
| ExcludeIds | Collection of integer |
None. |
|
| IncludeKeys | Collection of string |
None. |
|
| ExcludeKeys | Collection of string |
None. |
|
| FieldDataTypes | Collection of KendoGridFieldDataType |
None. |
|
| OptionalId | integer |
None. |
|
| OptionalIds | Collection of integer |
None. |
|
| SearchText | string |
None. |
|
| SearchFields | string |
None. |
|
| SearchMode | string |
None. |
|
| QueryType | string |
None. |
|
| ScoringProfile | string |
None. |
|
| TeamId | integer |
None. |
|
| CustomFacets | Collection of string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"take": 1,
"skip": 2,
"page": 3,
"filter": {
"logic": "sample string 1",
"filters": [
{
"field": "sample string 1",
"operator": "sample string 2",
"value": "sample string 3"
},
{
"field": "sample string 1",
"operator": "sample string 2",
"value": "sample string 3"
}
]
},
"sort": [
{
"field": "sample string 1",
"dir": "sample string 2"
},
{
"field": "sample string 1",
"dir": "sample string 2"
}
],
"additionalColumnDetails": [
{
"columnName": "sample string 1",
"alternatePredicateExpression": "sample string 2"
},
{
"columnName": "sample string 1",
"alternatePredicateExpression": "sample string 2"
}
],
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
],
"additionalFilters": [
{
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
],
"searchText": "sample string 1",
"source": 0
},
{
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
],
"searchText": "sample string 1",
"source": 0
}
],
"facetedSearchResultFilters": [
{
"filterKey": "sample string 1",
"name": "sample string 2",
"filters": [
{
"id": 1,
"name": "sample string 2",
"count": 3,
"checked": true,
"exclude": true,
"color": "sample string 6"
},
{
"id": 1,
"name": "sample string 2",
"count": 3,
"checked": true,
"exclude": true,
"color": "sample string 6"
}
],
"id": 3
},
{
"filterKey": "sample string 1",
"name": "sample string 2",
"filters": [
{
"id": 1,
"name": "sample string 2",
"count": 3,
"checked": true,
"exclude": true,
"color": "sample string 6"
},
{
"id": 1,
"name": "sample string 2",
"count": 3,
"checked": true,
"exclude": true,
"color": "sample string 6"
}
],
"id": 3
}
],
"pivotableInfo": {
"items": [
{
"filterKey": "sample string 1",
"requestCount": 2,
"dateOption": 0,
"gridFilterOverride": {
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
],
"searchText": "sample string 1",
"source": 0
},
"refineFilters": {
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
]
},
"uniqueGuid": "sample string 3",
"partitionResultOn": {
"filterKey": "sample string 1",
"count": 2
}
},
{
"filterKey": "sample string 1",
"requestCount": 2,
"dateOption": 0,
"gridFilterOverride": {
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
],
"searchText": "sample string 1",
"source": 0
},
"refineFilters": {
"facetedFilters": [
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
},
{
"filterKey": "sample string 1",
"value": "sample string 2",
"ids": [
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
},
{
"name": "sample string 1",
"deleted": true,
"valueId": 3,
"id": 4,
"parentId": 1,
"exclude": true
}
],
"op": 3,
"facetedSearchId": 4,
"enabled": true,
"deleted": true,
"id": 7,
"allMatchRequired": true
}
]
},
"uniqueGuid": "sample string 3",
"partitionResultOn": {
"filterKey": "sample string 1",
"count": 2
}
}
],
"useForPivot": true
},
"useFacetedSearchAdvancedFilters": true,
"showClientOnly": true,
"includeIds": [
1,
2
],
"excludeIds": [
1,
2
],
"includeKeys": [
"sample string 1",
"sample string 2"
],
"excludeKeys": [
"sample string 1",
"sample string 2"
],
"fieldDataTypes": [
{
"fieldName": "sample string 1",
"fieldDataType": "sample string 2"
},
{
"fieldName": "sample string 1",
"fieldDataType": "sample string 2"
}
],
"optionalId": 6,
"optionalIds": [
1,
2
],
"searchText": "sample string 7",
"searchFields": "sample string 8",
"searchMode": "sample string 9",
"queryType": "sample string 10",
"scoringProfile": "sample string 11",
"teamId": 1,
"customFacets": [
"sample string 1",
"sample string 2"
]
}
text/plain
Sample:
{"take":1,"skip":2,"page":3,"filter":{"logic":"sample string 1","filters":[{"field":"sample string 1","operator":"sample string 2","value":"sample string 3"},{"field":"sample string 1","operator":"sample string 2","value":"sample string 3"}]},"sort":[{"field":"sample string 1","dir":"sample string 2"},{"field":"sample string 1","dir":"sample string 2"}],"additionalColumnDetails":[{"columnName":"sample string 1","alternatePredicateExpression":"sample string 2"},{"columnName":"sample string 1","alternatePredicateExpression":"sample string 2"}],"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}],"additionalFilters":[{"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}],"searchText":"sample string 1","source":0},{"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}],"searchText":"sample string 1","source":0}],"facetedSearchResultFilters":[{"filterKey":"sample string 1","name":"sample string 2","filters":[{"id":1,"name":"sample string 2","count":3,"checked":true,"exclude":true,"color":"sample string 6"},{"id":1,"name":"sample string 2","count":3,"checked":true,"exclude":true,"color":"sample string 6"}],"id":3},{"filterKey":"sample string 1","name":"sample string 2","filters":[{"id":1,"name":"sample string 2","count":3,"checked":true,"exclude":true,"color":"sample string 6"},{"id":1,"name":"sample string 2","count":3,"checked":true,"exclude":true,"color":"sample string 6"}],"id":3}],"pivotableInfo":{"items":[{"filterKey":"sample string 1","requestCount":2,"dateOption":0,"gridFilterOverride":{"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}],"searchText":"sample string 1","source":0},"refineFilters":{"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}]},"uniqueGuid":"sample string 3","partitionResultOn":{"filterKey":"sample string 1","count":2}},{"filterKey":"sample string 1","requestCount":2,"dateOption":0,"gridFilterOverride":{"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}],"searchText":"sample string 1","source":0},"refineFilters":{"facetedFilters":[{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true},{"filterKey":"sample string 1","value":"sample string 2","ids":[{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true},{"name":"sample string 1","deleted":true,"valueId":3,"id":4,"parentId":1,"exclude":true}],"op":3,"facetedSearchId":4,"enabled":true,"deleted":true,"id":7,"allMatchRequired":true}]},"uniqueGuid":"sample string 3","partitionResultOn":{"filterKey":"sample string 1","count":2}}],"useForPivot":true},"useFacetedSearchAdvancedFilters":true,"showClientOnly":true,"includeIds":[1,2],"excludeIds":[1,2],"includeKeys":["sample string 1","sample string 2"],"excludeKeys":["sample string 1","sample string 2"],"fieldDataTypes":[{"fieldName":"sample string 1","fieldDataType":"sample string 2"},{"fieldName":"sample string 1","fieldDataType":"sample string 2"}],"optionalId":6,"optionalIds":[1,2],"searchText":"sample string 7","searchFields":"sample string 8","searchMode":"sample string 9","queryType":"sample string 10","scoringProfile":"sample string 11","teamId":1,"customFacets":["sample string 1","sample string 2"]}
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, text/plain
Sample:
Sample not available.