queryRules( )

Creates a query to retrieve a list of rules.

The queryRules() function builds a query to retrieve a list of up to 1,000 rules and returns a RulesQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function.

You can refine the query by chaining RulesQueryBuilder functions onto the query. RulesQueryBuilder functions enable you to sort, filter, and control the results that queryRules() returns. The functions that are chained to queryRules() are applied in the order they are called.

queryRules() runs with the following RulesQueryBuilder defaults that you can override:

• limit(50)
• ascending('entityId')

The following QueryRulesBuilder functions are supported for the queryRules() function. For a full description of the Rules object, see the object returned for the items property in RulesQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()