Filtering with `where` RSQL queries

This page describes how the where query parameter can be used to filter results.

Some resources - for example eventApiProducts or applicationRegistrations - offer a where query parameter as a means to provide a query string for filtering entities.. The query string is expressed in FIQL/RSQL language.

• Filter on document properties:
  ?where=brokerType==solace;state==RELEASED
• Sub elements can be queried with dot notation, for example plan.name==Gold matches all plans where the name starts with Gold. This also applies to querying nested arrays.
• Queries on attributes where the name and the value must match specific criteria can be expressed by grouping the name and value search criteria:
  ?where=(attributes.name==color;attributes.value==red)
  matches all objects where the value of attribute color starts with Bl such as Black or Blue.
• Queries on a combination of attributes are also possible:
  (attributes.name==color;attributes.value==Bl_);(attributes.name==flavour;attributes.value==_Berry) only matches documents where color starts with Bl and the flavour attribute ends in berry.

See https://github.com/jirutka/rsql-parser for details of the supported query operators and syntax.

🚧

applicationRegistrations/{registrationId}/accessRequests) does currently NOT support the where query parameter