Go to primary content
Oracle® Retail Bulk Data Integration Cloud Service Implementation Guide
Release 19.1.000
F31810-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

C Scheduler REST Endpoints

Scheduler provides RESTful services to retrieve information about schedules and run schedule manually.

The endpoint "discover" can be used to identify all endpoints provided by Scheduler.

REST Resource HTTP 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 1 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} POST Runs the specified schedule, that is, executes the Schedule Action of the schedule and returns the Schedule Execution detail response.This is synchronous invocation, so client needs to wait for the response.
/batch/schedules/executions/time/{fromDateTime}/{toDateTime} GET Returns schedule executions between from and to time
/batch/schedules/activateOrDisable-schedules POST To update status of one or more schdules to ACTIVE or DISABLED