Update a job
PATCH/jobs/:jobKey
Update a job with the given key.
Request
Path Parameters
The key of the job to update.
- application/json
Body
required
retries- The new amount of retries for the job; must be a positive number.timeout- The duration of the new timeout in ms, starting from the current moment.
changeset objectrequired
JSON object with changed job attribute values.
The following attributes can be adjusted with this endpoint, additional attributes will be ignored:
Providing any of those attributes with a null value or omitting it preserves the persisted attribute’s value.
The job cannot be completed or failed with this endpoint, use the complete job or fail job endpoints instead.
The new amount of retries for the job; must be a positive number.
The duration of the new timeout in ms, starting from the current moment.
Responses
- 204
- 400
- 404
- 409
- 500
The job was updated successfully.
The provided data is not valid.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The job with the jobKey is not found.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
The job with the given key is in the wrong state currently. More details are provided in the response body.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
An internal error occurred while processing the request.
- application/problem+json
- Schema
- Example (from schema)
Schema
Default value: about:blank
A URI identifying the problem type.
A summary of the problem type.
Possible values: >= 400 and <= 600
The HTTP status code for this problem.
An explanation of the problem in more detail.
A URI identifying the origin of the problem.
{
"type": "about:blank",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}