Skip to content

Latest commit

 

History

History
228 lines (133 loc) · 4.09 KB

retrieve-job-schedules-251658d.md

File metadata and controls

228 lines (133 loc) · 4.09 KB

Retrieve Job Schedules

This API retrieves all schedules for a specified job.

Routes

GET /scheduler/jobs/{jobId}/schedules

Request Parameters

Path

Parameter

Required

Data Type

Description

jobId

Yes

integer

ID of the job whose schedules have to be retrieved.

Body

Parameter

Required

Data Type

Description

page_size

No

number

Number of job schedules that the API retrieves.

If you haven't set page_size and only offset is specified, thepage_size parameter takes the value of 10 job schedules.

offset

No

number

Number of job schedules to skip. The default number is 1. The default offset is an indicator to fetch results without skipping any schedules.

Example

GET /scheduler/jobs/1/schedules?page_size=10&offset=1 

Responses

Status Code: 200

The API call was successful and the schedules were retrieved.

Example

{
				{
				"total": 2,
				"results": [
				{
				"scheduleId": "52cd418d-4a13-45fb-a9b7-b2b15f546d5f",
				"description": "updated scheudle",
				"data": "{\"order_id\":\"1234\"}",
				"type": "recurring",
				"cron": "* * * * 10 0 0",
				"repeatInterval": null,
				"repeatAt": null,
				"active": true,
				"startTime": "2015-10-20 00:00:00",
				"endTime": null,
				"time": null,
				"nextRunAt": "2017-08-11 10:00:00"
				}
				],
				"prev_url": "/scheduler/jobs/27/schedules?page_size=1",
				"next_url": null
				}

Status Code: 404

Passing invalid Job ID.

Related Information

Create Job

Configure Job (Using ID)

Configure Job (Using Name)

Delete Job

Retrieve Job Details

Retrieve All Jobs

Retrieve Job Run Logs

Retrieve Job Run Log Details

Update Job Run Log

Create Job Schedule

Configure Job Schedule

Delete Job Schedule

Activate or Deactivate All Job Schedules

Delete All Job Schedules

Retrieve Job Schedule Details