v1

latestOpenAPI 3.0.02026-07-2653703.5 MB
orgs/tasks

Create a new scheduled report task.

The cronTime value uses a restricted cron time format: minute hour day-of-month month days-of-week.Specifically, the cronTime is restricted to support only a daily, weekly, monthly or 1st day of the quarter. Daily is supported through a min hr * * * cronTime for daily execution at hr:min time. Weekly is supported through a min hr * * <day-of-week1>,<dow2>,... cronTime for weekly execution at hr:min time on <dow#> days (e.g. 0=Sunday, 1=Monday). Monthly is supported through a min hr day * * cronTime for monthly execution on <day> at hr:min time. 1st day of quarter is supported through a min hr 1 1,4,7,10 * cronTime for 1st day of quarter execution at hr:min time.<br/><br/>The randomDelaySecs provides the number of seconds to delay the start of execution. The minimum required delay is 3 hours.<br/><br/>The params field provides the report specific options. See /orgs/{orgId}/tasks/reports help for details.<br/><br/>JWT is required for this endpoint with at least one of the following scopes: o{params.orgId}-rpt:w,o{params.orgId}-rptGeneral:w,o:w,s-o:w<br/><br/>Endpoint name: createTasksReportsSchedule

post/orgs/{orgId}/tasks/reports/schedules

Path parameters

orgIdinteger required

Request body

cronTimestring required
cronTimeZonestring required
randomDelaySecsinteger required
optionsstring nullable

Response

Created