system.mes.schedule.findSchedules
Description
Retrieves Schedules based on the specified pagination, sort, and column constraint parameters.
Permissions
This scripting function has no client permission restrictions.
Syntax
Using Python keyword arguments, a Query Request can be passed to the findSchedules function
without specifying each parameter individually. Please refer to the Query Request documentation for a list of parameters.
system.mes.schedule.findSchedules(**queryRequest)
Returns
Returns a Query Result object with the following properties:
| Name | Type | Description |
|---|---|---|
content | List<Recipe> | The list of all records found that meet the specified criteria |
totalPages | Integer | If pagination is used, this is the number of total pages of records in the database for the specified page size. |
totalElements | Long | If pagination is used, this is the number of records in the database that meet the specified criteria. |
pageSize | Integer | If pagination is used, this is the specified page size. |
pageIndex | Integer | If pagination is used, this is the specified page index. |
hasContent | Boolean | True if an records were found that meet the specified criteria. |
isFirst | Boolean | If pagination is used, this is true if the first page was returned. |
isLast | Boolean | If pagination is used, this is true if the last page was returned. |
hasNext | Boolean | If pagination is used, this is true if there is a page of content available after this one. |
hasPrevious | Boolean | If pagination is used, this is true if there is a page of content available before this one. |
Code Examples
Here is an example of how to use a Query Request to retrieve the first ten Schedules created in 2024 sorted by their name.
queryRequest = system.mes.query.newQueryRequest()
queryRequest["pageSize"] = 10
queryRequest["pageIndex"] = 0
queryRequest["sortFields"] = ["name"]
queryRequest["sortDirection"] = "Ascending"
filterRequest = system.mes.query.newFilterRequest()
filterRequest["field"] = "createdDate"
filterRequest["condition"] = "between"
filterRequest["minDateValue"] = "2024-01-01T00:00:00Z"
filterRequest["maxDateValue"] = "2025-01-01T00:00:00Z"
filters = [filterRequest]
queryRequest["filters"] = filters
result = system.mes.schedule.findSchedules(**queryRequest)