FacetsSearchRequestContainer

FacetsSearchRequestContainer
FacetsSearchRequestContainer
JSON Example 
{
    "query": [
        {
            "key": "string",
            "value": "string",
            "values": [
                "string"
            ],
            "matchingMethod": "string",
            "negated": false,
            "start": 0,
            "end": 0
        }
    ],
    "limit": 0,
    "facets": [
        "string"
    ],
    "facetQuery": "string",
    "facetQueryMatchingMethod": "string"
}
array of SearchQuery
query
Optional

A list of queries by which to limit the search results. Entities that match ALL queries in this list constitute a set of 'entity search results'. All facets listed in the 'facets' search parameter of all entities within 'entity search results' are scanned to produce the search results (of facet values).

integer As int32 As int32
limit
Optional

The number of results to return. Default 100, Maximum allowed: 1000

array of string
facets
Required

A list of facets (property keys) to return values from found in entities matching 'query'. Examples are 'tags', 'creatorId', etc

string
facetQuery
Optional

A string against which facet results are compared. If the facet result either CONTAINs, STARTSWITH, or is an EXACT match for this value, as specified by facetQueryMatchingMethod, then it is returned

string
facetQueryMatchingMethod
Optional

The matching method used to filter when 'facetQuery' is used. Defaults to CONTAINS.

Possible values are : CONTAINS, STARTSWITH, EXACT, TAGPATH,
Parameter To