Download OpenAPI specification:Download
Contains methods to execute/schedule background jobs
contextId required | string |
Authorization required | string The BasicAuth token |
isHeartbeat | boolean |
isSuccessful | boolean |
resultCode | integer <int32> |
message | string |
Success
{- "isHeartbeat": true,
- "isSuccessful": true,
- "resultCode": 0,
- "message": "string"
}
Authorization required | string The BasicAuth token |
The parameter DTO
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
Success
Incorrect/missing parameters
{- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}
}
Authorization required | string The BasicAuth token |
The parameter DTO
delay | string The timespan to delay until the job gets executed |
enqueueAt | string <date-time> The specific time when the job should get executed. Given in UTC. |
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
Success
Incorrect/missing parameters
{- "delay": "string",
- "enqueueAt": "2020-11-23T16:28:42Z",
- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}
}
Authorization required | string The BasicAuth token |
The parameter DTO
jobId | string The unique ID of the Job |
cronExpression | string The Cron expression that defines the recurring schedule |
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
Success
Incorrect/missing parameters
{- "jobId": "string",
- "cronExpression": "string",
- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}
}
Authorization required | string The BasicAuth token |
The parameter DTO
jobId | string The unique ID of the Job |
cronExpression | string The Cron expression that defines the recurring schedule |
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
Success
Incorrect/missing parameters
{- "jobId": "string",
- "cronExpression": "string",
- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}
}