THthoughtspot

Update a report schedule

Updates a Report's Schedule

patch/{workspace}/reports/{report}/schedules/{schedule}

Request

Path parameters

workspacestring required

Workspace username

reportstring required

Report token

schedulestring required

Schedule token

Request body

namestring

The name of the schedule

timeoutinteger

How long, in seconds, the system should wait before it decides the schedule should run again even if the last run has not completed

paramsReportScheduleRequestBodyParamsProperty

A set of key/value pairs that match report parameter names and values, if the report for this schedule has any and you would like to schedule it with specific values

Example request

{
  "cron": {
    "freq": "hourly",
    "day_of_month": 15,
    "day_of_week": 5,
    "hour": 8,
    "time_zone": "Pacific Time (US & Canada)"
  },
  "name": "Qui Officia",
  "timeout": 3600,
  "params": {
    "foo": "bar"
  }
}

Response

Report Schedule response

namestring required
tokenstring required
parametersstring required
created_atstring required
updated_atstring required
retry_statestring required
retry_countstring required
retry_delaystring required
timeoutstring required
last_run_atstring required
last_succeeded_atstring required
last_scheduled_runstring required
next_scheduled_runstring required
report_namestring required
deliverystring required
report_tokenstring required
report_typestring required
subscribedstring required
subscriber_countstring required
_embeddedunknown

Changes

No recorded changes to this operation across all 28 revisions of this API.