Skip to main content

FilterCapability

Describes a search filter field the implementation supports. The type tells clients which UI element suits the field (e.g. a date picker for date, a toggle for boolean) and which request syntax the field accepts: date and number filters accept a single range object or a non-empty array of range objects (matched as an OR of the ranges) as well as an array of values; string and boolean filters accept an array of values only.

New filter types are added by revision of this specification; clients MUST hide filters with a type value they do not recognise rather than fail.

typestringrequired

The filter's value type. date values are ISO 8601 strings. boolean values are the strings "true" and "false".

Possible values: [string, date, number, boolean]

Example: date
labelstring

An optional human-readable display label for the filter field.

Example: Date created
FilterCapability
{
  "type": "date",
  "label": "Date created"
}