latestOpenAPI 3.0.12026-08-10434791.3 KB

4eedf1838ef4

Schedule

Skip future sessions by count or time

post/api/schedules/{id}/skip

Path parameters

idinteger required

session id

Request body

countinteger

skip given number of sessions. nextTime or (fromTime and count) are required.

dryRunboolean required

dry run

fromTimestring date-time

skip before the time. nextTime or (fromTime and count) are required.

nextRunTimestring date-time

next run time

nextTimestring

next time. nextTime or (fromTime and count) are required.

Example request

{
  "fromTime": "2023-08-18T06:52:33Z",
  "nextRunTime": "2023-08-18T06:52:33Z",
  "nextTime": "2022-12-31T23:59:00+00:00"
}

Response

default response

createdAtstring date-time required

created time

disabledAtstring date-time

disabled time

idstring required

schedule ID

nextRunTimestring date-time required

next run time

nextScheduleTimestring required

next schedule time

updatedAtstring date-time required

updated time

Example response

{
  "createdAt": "2023-08-18T06:52:33Z",
  "disabledAt": "2023-08-18T06:52:33Z",
  "id": "123456",
  "nextRunTime": "2023-08-18T06:52:33Z",
  "nextScheduleTime": "2022-12-31T23:59:00+00:00",
  "project": {
    "id": "123456",
    "name": "abcdefg"
  },
  "updatedAt": "2023-08-18T06:52:33Z",
  "workflow": {
    "id": "123456",
    "name": "abcdefg"
  }
}