This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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() ,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() ,ascending() ,descending() |
details.benefits.providerAppId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
namespace | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.