Download OpenAPI specification:Download
Contains methods to execute/schedule background jobs
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
jobId | string Nullable The unique ID of the Job |
cronExpression | string Nullable The Cron expression that defines the recurring schedule |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}, - "jobId": "string",
- "cronExpression": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
jobId | string Nullable The unique ID of the Job |
cronExpression | string Nullable The Cron expression that defines the recurring schedule |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}, - "jobId": "string",
- "cronExpression": "string"
}
{- "code": "BadRequest",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}
}
{- "jobId": "string"
}
Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
jobParameters | object (JobParameters) The actual parameters passed to a job when executed |
delay | object (TimeSpan) |
enqueueAt | string <date-time> Nullable The specific time when the job should get executed. Given in UTC. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "jobParameters": {
- "backgroundJobId": 0,
- "name": "string",
- "data": "string",
- "canUseDefaultParametersData": true
}, - "delay": {
- "ticks": 0
}, - "enqueueAt": "2022-12-20T12:45:21Z"
}
{- "jobId": "string"
}