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 programs.
The Query Programs method builds a query to retrieve a list of programs and returns a ProgramsQueryBuilder
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 ProgramsQueryBuilder
methods onto the query. ProgramsQueryBuilder
methods enable you to filter, sort, and control the results that Query Programs returns.
Query Programs 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 ProgramsQueryResult
.
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() |
programDefinitionId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
status | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
namespace | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
externalId | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
programDefinition.id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,gt() ,lt() ,le() ,ge() ,ascending() ,descending() |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.