A Appendix A: Scheduler REST Endpoints

The Scheduler provides RESTful services to retrieve information about schedules and to run the scheduler manually. The endpoint discover can be used to identify all endpoints provided by the Scheduler.

REST Resource Descriptions

The following table describes the REST resources.

Table A-1 REST Resource Descriptions

REST Resource	Method	Description
/discover	GET	Lists all the available Scheduler REST resources
/batch/schedules	GET	Returns all the schedules in the application (including active, inactive and disabled schedules)
/batch/schedules/active-schedules	GET	Returns all active schedules
/batch/schedules/{scheduleName}	GET	Returns the schedule definition of the specified schedule
/batch/schedules/upcoming-schedules/days/{days}	GET	Returns the upcoming schedules from now to next number of {days} specified
/batch/schedules/upcoming-schedules	GET	Returns the upcoming schedules for the next one day from now
/batch/schedules/executions/{scheduleName}	GET	Returns all the historical schedule executions of the given schedule since the beginning
/batch/schedules/executions/past/days/{days}	GET	Returns the historical schedule executions of the given schedule for past number of {days}
/batch/schedules/executions/failed	GET	Returns all the failed executions for all the schedules since the beginning
/batch/schedules/executions/today	GET	Returns today's schedule executions starting from midnight today (12:00 a.m.) to now
/batch/schedules/executions/today/completed	GET	Returns today's schedule executions that are either in 'Triggered' status (for async actions) or in 'Completed' status (for sync actions), starting from midnight today (12:00 a.m.) to now
/batch/schedules/executions/today/failed	GET	Returns today's schedule executions that are in 'Failed' status, starting from midnight today (12:00 a.m.) to now
/batch/schedules/executions/past/days/{days}	GET	Returns schedule executions for last n days
/batch/schedules/operator/run-schedule-now/{scheduleName}	GET	Runs the specified schedule, that is, executes the Schedule Action of the schedule and returns the Schedule Execution detail response.This is a synchronous invocation, so client must wait for the response.
/batch/schedules/executions/time/{fromDateTime}/{toDateTime}	GET	Returns schedule executions between from and to time