default_filters entry on a topic or composite topic as required. Users can still change the filter’s value, but they can’t remove the filter from the query. If a query ends up with no value for the field (for example, a user clears it), Omni reapplies the declared default.
required is only meaningful inside a topic or composite topic’s default_filters. Setting it on always_where_filters or always_having_filters has no effect.
A required entry must specify a value. You can’t set required: true without also giving the filter a value.
Syntax
Properties
object
required
The field to filter on.
any
required
The filter operator and value to apply. Refer to the filter syntax documentation for available operators like
is, not, contains, greater_than, etc.boolean
If
true, users can change the filter’s value but can’t remove the filter from the query. If a query omits the field or clears its value, Omni reapplies the declared default.