Contents

QueryFilter

A single filter condition in a query request, specifying a field, comparison operator, and one or more values to match against.

Declaration

object QueryFilter

Properties

NameTypeDescription
fieldstring

The name of the field to filter on (for example, id, name).

operatorQueryFilterOperator

Comparison operator. Supported operators (may vary by endpoint): BETWEEN, CONTAINS_ALL, CONTAINS_ANY, ENDS_WITH, EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, IS_NOT_NULL, IS_NULL, LESS_THAN, LESS_THAN_OR_EQUAL_TO, LIKE, NOT_CONTAINS_ALL, NOT_CONTAINS_ANY, NOT_EQUALS, NOT_IN, NOT_LIKE, STARTS_WITH. See QueryFilterOperator.

valueQueryFilter.Value

One or more filter conditions applied to the result set. Pass an array for operators that accept multiple values (IN, NOT_IN, CONTAINS_ANY, CONTAINS_ALL, NOT_CONTAINS_ANY, NOT_CONTAINS_ALL), an array of exactly two values ordered as [minimum, maximum] for BETWEEN, a scalar for single-value operators such as STARTS_WITH, either a scalar or a single-element array for EQUALS, or omit entirely for the null-check operators IS_NULL and IS_NOT_NULL.

ignoreCaseboolean

Whether to perform case-insensitive filtering.

Discussion

The QueryFilter defines one filter condition in a QueryRequest.filters array. Not all endpoints support all operators. Refer to each entity’s Properties section for the supported operators per field.

Example

{
  "field": "name",
  "operator": "CONTAINS_ANY",
  "value": ["AwayFinder", "AwayFinder Promo"],
  "ignoreCase": true
}

Topics

Dictionaries

See Also

Query Objects