How can the search parameter be used on an endpontendpoint? How does the search syntax work?
| Table of Contents |
|---|
...
Search
Pass the user search value into the search parameter.The , the search value itself is transformed by the API to support a more natural (google) search!
...
The search words are matched against the columns defined per specific endpoint, see below
...
.
Input
Search = text, string
Output
JSON
filtered result set of the items
Sample
| Code Block | ||
|---|---|---|
| ||
# Sample: BMW
BMW
Result:
All results with BMW
# Sample: Citroën
Citroën
Result:
All results with CITROEN
# Sample: BMW 5-series
BMW 5-series
Result:
All results with:
BMW <AND> 5SERIES |
Specifics per endpoint
Per endpoint search can be used only on the fields that are available on the model for the specific endpoint. See below for more information.
...
Columns |
|---|
firstname |
lastname |
shortname |
company_name |
Orders
The following columns are used for the search
...
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|