Skip future sessions by count or time

Request

Security

ApiKeyAuth

Path

idinteger, (int32)required

session id

Bodyapplication/json

countinteger, (int32)

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

dryRunbooleanrequired

dry run

fromTimestring, (date-time)

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

Example:"2023-08-18T06:52:33Z"

nextRunTimestring, (date-time)

next run time

Example:"2023-08-18T06:52:33Z"

nextTimestring

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

Example:"2022-12-31T23:59:00+00:00"

curl -i -X POST \
  'https://api-workflow.treasuredata.com/api/schedules/{id}/skip' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 0,
    "dryRun": true,
    "fromTime": "2023-08-18T06:52:33Z",
    "nextRunTime": "2023-08-18T06:52:33Z",
    "nextTime": "2022-12-31T23:59:00+00:00"
  }'

Responses

default response

Bodyapplication/json

createdAtstring, (date-time)required

created time

Example:"2023-08-18T06:52:33Z"

disabledAtstring, (date-time)

disabled time

Example:"2023-08-18T06:52:33Z"

idstringrequired

schedule ID

Example:"123456"

nextRunTimestring, (date-time)required

next run time

Example:"2023-08-18T06:52:33Z"

nextScheduleTimestringrequired

next schedule time

Example:"2022-12-31T23:59:00+00:00"

projectobject(IdAndName)required

Name and ID

updatedAtstring, (date-time)required

updated time

Example:"2023-08-18T06:52:33Z"

workflowobject(IdAndName)required

Name and ID

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"
  }
}