Creates a query to retrieve a list of participations.
The queryParticipations() function builds a query to retrieve a list of participations and returns a ParticipationsQueryBuilder 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 ParticipationsQueryBuilder functions onto the query. ParticipationsQueryBuilder functions enable you to sort, filter, and control the results that queryParticipations() returns.
queryParticipations() runs with the following ParticipationsQueryBuilder default that you can override:
limit is 50.createdDate in ascending order.The functions that are chained to queryParticipations() are applied in the order they are called.
The following ParticipationsQueryBuilder functions are supported for the queryParticipations() function. For a full description of the participations object, see the object returned for the items property in ParticipationsQueryResult.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
scheduleId | eq(),in() |
eventId | eq(),in() |
_id | in() |
externalId | eq(),in() |
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.