Job Queue
Cancel a job
Changed onSends an asynchronous cancellation request for the specified job. The job may still complete if it has already finished or cannot be interrupted.
post/api/v1/jobs/{jobId}/cancel
Request
- Base URLhttps://docs.anzworldline-solutions.com.au
- Authnone declared
- TypeScripthttps://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/docs/api/v1/jobs/:jobId/cancel/post.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
jobIdstring uuid required
Example:e6d9bae8-657b-4e2f-8524-c0222db66355
Unique identifier (UUID) of the job to cancel.
Response
Cancellation request accepted.
Changes
- breaking
for the
pathrequest parameterjobId, the format changed from no format touuid - info
api operation id
cancelJobremoved and replaced withcancelJobQueueJob - info
api tag
Job Queueadded - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the success response with the status
- breaking