QueryFilter document (Data API 18.8)
Document representing a query filter. A query filter wraps any query
and allows it to be used as a filter.
Example: (coupond_id contains "disabled" AND (enabled=false OR
active=false))
query : {
filtered_query: {
query: { text_query: { fields: ["coupon_id"], search_phrase: "disabled" } },
filter: {
query_filter: {
query: {
term_query: { fields: ["enabled","active"], operator: "is", values: [ false ] }
}
}
}
}
}
| Property | Type | Constraints | Description |
|---|---|---|---|
query
|
Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery} | mandatory=true, nullable=false | The query, which should be used as a filter. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.