FailJobRequest
Loading ....
Source:
{
"$id": "io.miranum.bpmn.command.v1.FailJobRequest",
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"jobKey": {
"description": "the unique job identifier, as obtained when activating the job",
"type": "number"
},
"retries": {
"description": "the amount of retries the job should have left",
"type": "number"
},
"errorMessage": {
"description": "an optional message describing why the job failed\nthis is particularly useful if a job runs out of retries and an incident is raised,\nas it this message can help explain why an incident was raised",
"type": "string"
},
"retryBackOff": {
"description": "the backoff timeout (in ms) for the next retry",
"type": "number"
},
"variables": {
"description": "JSON document that will instantiate the variables at the local scope of the\njob's associated task; it must be a JSON object, as variables will be mapped in a\nkey-value fashion. e.g. \"a\": 1, \"b\": 2 will create two variables, named \"a\" and\n\"b\" respectively, with their associated values. \"a\": 1, \"b\": 2 would not be a\nvalid argument, as the root of the JSON document is an array and not an object.",
"type": "string"
}
}
}