Sign in

v1

latestOpenAPI 3.0.02026-07-26221117272.0 KB
Facet

Get facets

Retrieves all facets created in HawkSearch

get/api/v11/Facet

Headers

X-HawkSearch-ApiKeystring required

Response

OK

SyncGuidstring uuid
FacetIdinteger
Namestring required
FacetTypestring required
FieldTypestring required
MaxCountinteger required
MinHitCountinteger required
Fieldstring required
Paramstring
DisplayTypestring required
ScrollHeightinteger required
ScrollThresholdinteger required
TruncateThresholdinteger required
SearchThresholdinteger required
SortOrderinteger required
ExpandSelectionboolean required
IsCurrencyboolean required
IsNumericboolean required
IsSearchboolean required
IsVisibleboolean required
UBoundstring
LBoundstring
Incrementstring
NofVisibleinteger
Heightinteger
DisplayRuleXMLstring
SortBystring
ParentIdinteger
IsCollapsibleboolean required
IsCollapsedDefaultboolean required
SwatchDatastring
FacetRangeDisplayTypeinteger
PreloadChildrenboolean
Tooltipstring
ShowSliderInputsboolean required
ShowFacetImageCountboolean
Tagsstring
CreateDatestring date-time
ModifyDatestring date-time
ListNamestring
NumericPrecisioninteger
CurrencySymbolstring
DefaultItemTypestring

Example response

[
  {
    "SyncGuid": "00000000-0000-0000-0000-000000000000"
  }
]