Creates a query to retrieve a list of pool definitions.
The Query Pool Definitions method builds a query to retrieve a list of pool definitions and returns a PoolDefinitionsQueryBuilder object.
The returned object contains the query definition, which is used to run the query using the find() method.
You can refine the query by chaining PoolDefinitionsQueryBuilder methods onto the query. PoolDefinitionsQueryBuilder methods enable you to filter, sort, and control the results that Query Pool Definitions returns.
Query Pool Definitions has a default paging limit of 50, which you can override.
For a full description of the item object, see the object returned for the items property in PoolDefinitionsQueryResult.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
_createdDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
programDefinitionIds | eq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending() |
details.benefits.itemSetId | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
details.benefits.providerAppId | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
namespace | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.