querySchedules( )

Creates a query to retrieve a list of schedules.

The querySchedules() function builds a query to retrieve a list of tip settings and returns a SchedulesQueryBuilder 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 SchedulesQueryBuilder functions onto the query. SchedulesQueryBuilder functions enable you to sort, filter, and control the results that querySchedules() returns.

querySchedules() runs with the following SchedulesQueryBuilder default that you can override:

• limit is 50.
• Sorted by id in ascending order.

The functions that are chained to querySchedules() are applied in the order they are called. For example, if you apply ascending("status") and then ascending("externalId"), the results are sorted first by the "status", and then, if there are multiple results with the same "status", the items are sorted by "externalId".

The following SchedulesQueryBuilder functions are supported for the querySchedules() function. For a full description of the tip settings object, see the object returned for the items property in SchedulesQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),in()
externalId	eq(),in()
status	eq(),in()
appId	eq(),in()