X

The Integration blog covers the latest in product updates, best practices, customer stories, and more.

OIC Scheduling REST APIs

Sumeet Singh
Principal Member of Technical Staff

Synopsis:

This blog describes OIC Scheduling REST APIs, which allow users to fulfill various actions related to schedules.

 

Schedule CRUD

Refer to this blog for details about creating, updating schedules.

 

Schedule Lifecycle

REST API endpoint: ic/api/integration/v1/integrations/{id}/schedule

 

1. How to start a schedule?

HTTP Method: POST
PATH: ic/api/integration/v1/integrations/{id}/schedule/start
Example: ic/api/integration/v1/integrations/SCH_ONE|01.00.0000/schedule/start

JSON request payload: {}

 

 

2. How to pause a schedule?

HTTP Method: POST
PATH: ic/api/integration/v1/integrations/{id}/schedule/pause
Example: ic/api/integration/v1/integrations/SCH_ONE|01.00.0000/schedule/pause

JSON request payload: {}

 

3. How to resume a schedule?

HTTP Method: POST
PATH: ic/api/integration/v1/integrations/{id}/schedule/resume
Example: ic/api/integration/v1/integrations/SCH_ONE|01.00.0000/schedule/resume

JSON request payload: {}

 

4. How to stop a schedule?

HTTP Method: POST
PATH: ic/api/integration/v1/integrations/{id}/schedule/stop
Example: ic/api/integration/v1/integrations/SCH_ONE|01.00.0000/schedule/stop

JSON request payload: {}

 

Scheduled Jobs

V1 REST API endpoint: ic/api/integration/v1/integrations/{id}/schedule

1. How to submit a runNow scheduled job?

HTTP Method: POST
PATH: 
ic/api/integration/v1/integrations/{id}/schedule/jobs
Example: ic/api/integration/v1/integrations/SCH_ONE|01.00.0000/schedule/jobs

 

Schedule Future runs

V1 REST API endpoint: ic/api/integration/v1/integrations/{id}/schedules

1. How to fetch/get schedule future runs?

HTTP Method: GET
PATH: 
ic/api/integration/v1/integrations/{id}/schedules/{schedule_id}/futureruns
Example: ic/api/integration/v1/integrations/SCH_ONE%7C01.00.0000/schedules/Run_SCH_ONE_01_00_0000/futureruns

 

Schedule Runs

V1 REST API endpoint: ic/api/integration/v1/integrations/schedules/runs/{request_id}

1. How to delete/cancel schedule run?

HTTP Method: DELETE
PATH: 
ic/api/integration/v1/integrations/schedules/runs/{request_id}
Example: ic/api/integration/v1/integrations/schedules/runs/3165

 

RunRequests API (Schedule Bulk Operations)

V1 REST API endpoint: ic/api/integration/v1/runrequests

1. How to fetch/get list of all scheduled run requests across integrations?

HTTP Method: GET
PATH: 
ic/api/integration/v1/runrequests
Example: ic/api/integration/v1/runrequests

 

2. How to fetch/get particular scheduled run request?

HTTP Method: GET
PATH: 
ic/api/integration/v1/runrequests/{id}
Example: ic/api/integration/v1/runrequests/2891

 

3. How to start all schedules of all the ACTIVE scheduled integrations?

HTTP Method: POST
PATH: 
ic/api/integration/v1/runrequests/start
Example: ic/api/integration/v1/runrequests/start

 

4. How to pause all schedules of all the ACTIVE scheduled integrations?

HTTP Method: POST
PATH: 
ic/api/integration/v1/runrequests/pause
Example: ic/api/integration/v1/runrequests/pause

 

5. How to resume all schedules of all the ACTIVE scheduled integrations?

HTTP Method: POST
PATH: 
ic/api/integration/v1/runrequests/resume
Example: ic/api/integration/v1/runrequests/resume

 

6. How to stop all schedules of all the ACTIVE scheduled integrations?

HTTP Method: POST
PATH: 
ic/api/integration/v1/runrequests/stop
Example: ic/api/integration/v1/runrequests/stop

 

7. How to delete a particular scheduled run request?

HTTP Method: DELETE
PATH:
 ic/api/integration/v1/runrequests/{id}
Example: ic/api/integration/v1/runrequests/2891

 

 

 

 

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.