Add scheduler task.
POST/operator/scheduler/add
Add scheduler task.
Request
Header Parameters
ipaas string
- application/json
Bodyrequired
1
: One time execution.intervalOptions
must be a unix timestamp or ISO 8601 date.2
: Multiple specific executions.intervalOptions
must be an array of unix timestamps or ISO 8601 dates.3
: Cron job.intervalOptions
must be a cron string.4
: Regular execution every n hours / days / weeks / months.intervalOptions
must be a string of the formatperiod;n
.- string
- array
- number
- array
- Array [
- ]
- Array [
- ]
sendToWebhookstringrequired
The URL of the webhook that will be called with the specified data every time the task is run.
datastringrequired
The JSON data that will be passed to the webhook.
intervalTypestringrequired
The type of scheduler that will be set up. The different options are:
Possible values: [1
, 2
, 3
, 4
]
intervalOptions objectrequired
anyOf
string
string
number
number
endDatestring<date-time>
The last date this task will be executed.
Responses
- 200
- 400
Success
- application/json
- Schema
- Example (auto)
Schema
taskIdstringrequired
The unique ID for this task, which can be used for managing the task later.
nextExecutionstring<date-time>required
The date this task will be executed next.
endDatestring<date-time>
The end date that was provided.
{
"taskId": "string",
"nextExecution": "2024-07-29T15:51:28.071Z",
"endDate": "2024-07-29T15:51:28.071Z"
}
Bad Request
- application/json
- Schema
- Example (auto)
Schema
statusnumber
errorMessagestring
{
"status": 0,
"errorMessage": "string"
}