Result Object🔗︎
MatchSize 🔗︎ integer
MatchSize🔗︎
Total number of results found by the searcher (can differ from the number of returned items).
HasMoreResults 🔗︎ boolean
HasMoreResults🔗︎
Whether there are more result items for this query that did not fit in the response (more can be requested using the resultOffset request parameter).
ResultItems 🔗︎ object[]
ResultItems🔗︎
List of result items.
ResultItems properties
DocID 🔗︎ string
DocID🔗︎
The document ID (given at indexing time) or the document link (in case of external searchers).
QueryParts 🔗︎ object[]
QueryParts🔗︎
All query parts of the executed query. They are aligned in order with the query part scores contained in the ResultItems.
QueryParts properties
Condition 🔗︎ enum
Condition🔗︎
The conditionType of the represented query part. Allowed values: REQUIRED, BANNED, FAVORED, STRONGLY_FAVORED.
Weight 🔗︎ float
Weight🔗︎
The weight of the query part compared to other query parts in the the ranking of results.
Items 🔗︎ object[]
Items🔗︎
One or more search terms of which at least one must be in the searched document (OR-combined).
Items properties
Synonyms 🔗︎ string[]
Synonyms🔗︎
The list of automatically expanded synonyms for this query part item.
SubParts 🔗︎ object[]
SubParts🔗︎
An object[] of QueryParts defined above. See List of QueryParts
IsOrCombined 🔗︎ boolean
IsOrCombined🔗︎
Flag indicating that the new query part has been OR combined with a query part in the given queryParts (so that the API-client must do the same).
TransformedQuery 🔗︎ string
TransformedQuery🔗︎
Transformed query, as sent to the underlying searcher. Returned only if AccessOptions.transformedQueryAccess was set to true when authenticating.
FacetCounts 🔗︎ object[]
FacetCounts🔗︎
An object[] representing Facets.
FacetCounts properties
DataType 🔗︎ enum
DataType🔗︎
The data type of the facet field. Possible values: TEXT, LONG_TEXT, NUMERIC, DATE, LOCATION.
CombinationType 🔗︎ enum
CombinationType🔗︎
The combination type defines how multiple facet selections are combined in a REQUIRED conditional query. Allowed values: AND, OR, SINGLE. AND means that the results must contain all selections, (e.g. English AND French language skill), OR means that the reuslts must contain one of the selections (e.g. Master OR Bachelor level), and SINGLE means that the facet is restricted to contain only one selection. OR is the default.
CombinationTypeSpecified 🔗︎ boolean
CombinationTypeSpecified🔗︎
Whether CombinationType is specified or not.
GuiType 🔗︎ enum
GuiType🔗︎
The GUI type determines whether a facet should be displayed as a fixed item facet or as a tag cloud. Allowed values: FIXED, DYNAMIC, CLOUD, TEXTFIELD, LOCATION, or PROJECT. For the FIXED and DYNAMIC facet types the items are shown in the Search! UI as a list preceded by checkboxes. If the initially returned list of items is over 25, the display (in the Search! UI) will switch to an 'autocomplete select mode' to make it easier to search & select items in the list.
CloudType 🔗︎ enum
CloudType🔗︎
The cloud type determines the display layout of the cloud. Allowed values: SPHERE, SPREAD, LIST, COLUMNS1, COLUMNS2, COLUMNS3.
HideFacetIfAllZero 🔗︎ boolean
HideFacetIfAllZero🔗︎
If true the facet will be hidden when all items have zero counts.
HideFacetIfAllZeroSpecified 🔗︎ boolean
HideFacetIfAllZeroSpecified🔗︎
Whether HideFacetIfAllZero is specified or not.
HideZeroCountItems 🔗︎ boolean
HideZeroCountItems🔗︎
If true items having a zero count will be hidden. This cannot be set when the fixed facet has showOnWidget set to True. This is also not adviced on FIXED and DYNAMIC type facets with an expected initial returned list of items higher than 25 as it hides selected values when in the 'autocomplete select mode' as described below.
HideZeroCountItemsSpecified 🔗︎ boolean
HideZeroCountItemsSpecified🔗︎
Whether HideZeroCountItemsSpecified is specified or not.
DefaultCondition 🔗︎ enum
DefaultCondition🔗︎
Default condition type. Allowed Values: FAVORED, STRONGLY_FAVORED, and REQUIRED.
DefaultConditionSpecified 🔗︎ boolean
DefaultConditionSpecified🔗︎
Whether DefaultCondition is specified or not.
HideConditionWidget 🔗︎ boolean
HideConditionWidget🔗︎
If true the condition widget will be hidden.
HideConditionWidgetSpecified 🔗︎ boolean
HideConditionWidgetSpecified🔗︎
Whether HideConditionWidget is specified or not.
ReverseItemOrder 🔗︎ boolean
ReverseItemOrder🔗︎
If true, items will be displayed in reverse order.
ReverseItemOrderSpecified 🔗︎ boolean
ReverseItemOrderSpecified🔗︎
Whether ReverseItemOrder is specified or not.
Items 🔗︎ object[]
Items🔗︎
The items belonging to a FIXED item facet, null for a CLOUD facet.
Items properties
Distances 🔗︎ string[]
Distances🔗︎
The selectable distances belonging to a LOCATION facet, otherwise empty.
DefaultDistance 🔗︎ string
DefaultDistance🔗︎
Optional default distance within a LOCATION facet's distance selector (if not defined it is the first entry).
TextInputOnFacet 🔗︎ boolean
TextInputOnFacet🔗︎
Determines whether for CLOUD facets the input box is displayed in the facet bar, otherwise within the tag-cloud.
TextInputOnFacetSpecified 🔗︎ boolean
TextInputOnFacetSpecified🔗︎
Whether TextInputOnFacet is specified or not.
ShowOnFacetSpecified 🔗︎ boolean
ShowOnFacetSpecified🔗︎
Whether ShowOnFacet is specified or not.
ChildFacets 🔗︎ object[]
ChildFacets🔗︎
The facets belonging to this group. See List of FacetCounts.
SubFacets 🔗︎ object[]
SubFacets🔗︎
The subfacets belonging to this group. See List of FacetCounts.
SearchEngine 🔗︎ string
SearchEngine🔗︎
Optional searchEngine name set only for exclusive facets.
DropdownSwitcherThreshold 🔗︎ int
DropdownSwitcherThreshold🔗︎
Optional attribute allows changing the default threshold number which controls the switching between checkboxes/dropdown components. If not present, the default value is 25. This attribute is only applicable when guitype is fixed or dynamic.
SearchEngine 🔗︎ string
SearchEngine🔗︎
The name of the searcher that has been used to process the request.
Synonyms 🔗︎ object[]
Synonyms🔗︎
List of actual synonyms per language.
Synonyms properties
Value 🔗︎ object[]
Value🔗︎
An object[] representing the value of the key.
Value properties
Name 🔗︎ string
Name🔗︎
Arbitrary string read from the configuration file, representing a name of the section. Used for grouping Synonym Items in the GUI widget.
Collapsed 🔗︎ boolean
Collapsed🔗︎
Determines whether this section is collapsed in the GUI widget.
QueryContext 🔗︎ object
QueryContext🔗︎
Optional. Stores additional information about the query.
QueryContext properties