Job Cancel
job_cancelStop a running job and return its state as cancelled. If the operation cannot be interrupted, it returns WRONG_STATE and leaves the job running; completed jobs are unchanged.
Instructions
Stop a running job and return its state ("cancelled").
A job whose operation cannot be interrupted returns WRONG_STATE and keeps running; a finished job is returned unchanged. Check it first with job_status if unsure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | Id from a write that returned status='started' (or job_list). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| kind | Yes | ||
| error | No | ||
| label | Yes | ||
| state | Yes | ||
| result | No | ||
| progress | No | ||
| started_at | Yes | ||
| finished_at | No |