Search Suggestion

The Search API supports suggestion. This means that a search result contains possible values for a certain field.
Both a GET and POST request are available. The same parameters are available. The GET request expects these parameters to be part of the URL while the POST request expects them to be in the body of the request.

Syntax: /products/suggest/{attribute}/{seachtText}/{locale}?filter={filter}

Attribute

This is the name of the attribute that you want to suggest values for.

Search text

The search text that needs to be applied to suggest values.
Note: Searching on parts of words is supported as from 3 characters.

Locale

This is an optional parameter to define the locale

Filter

This option supports filtering on suggestion search results. This feature works the same like the filter option in a search request.

Examples

GET - Response

/products/suggest/designName/deter/en?filter=status.eq.RN

{
"results": [{
"category": "designName",
"filter": {
"filter": "designName.eq.Determination",
"fieldName": "designName",
"comparison": 1,
"value": "Determination",
"title": "Determination"
}
}],
"searchText": "deter"
}

POST - Request

/products/suggest

{
"attribute": "designName",
"searchText": "deter",
"filter": "status.eq.RN"
}