queryProgramDefinitions( )


Developer Preview

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 program definitions.

The Query Program Definitions method builds a query to retrieve a list of program definitions and returns a ProgramDefinitionsQueryBuilder 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 ProgramDefinitionsQueryBuilder methods onto the query. ProgramDefinitionsQueryBuilder methods enable you to filter, sort, and control the results that Query Program Definitions returns.

Query Program 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 ProgramDefinitionsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
namespaceeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
externalIdeq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending()
Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
SCOPE.BENEFIT_PROGRAMS.READ
Manage Events
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?