Cancel Job

Cancel a job if it hasn’t been completed yet.

Returns the updated job on success, 404 if job not found or already terminal.

Cancel Job

cURL

curl --request POST \
  --url https://api.ionworks.com/jobs/{job_id}/cancel

200

{
  "job_id": "<string>",
  "job_type": "dummy",
  "status": "pending",
  "priority": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "organization_id": "<string>",
  "is_terminal": true,
  "is_failed": true,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "compute_time": 123,
  "error": "<string>",
  "error_code": "EXECUTION_TIMEOUT",
  "result": {},
  "callback_url": "<string>",
  "parent_job_id": "<string>",
  "project_id": "<string>",
  "access_level": "organization",
  "params_path": "<string>",
  "metadata_path": "<string>"
}

Path Parameters

job_id · string · required

The ID of the job to cancel

Response

200

application/json

Successful Response

Schema for job information response

job_id · string · required

job_type · enum<string> · required

Possible types for a job

Available options: dummy, datafit, validation, simulate, evaluate_variables, optimize

status · enum<string> · required

Possible statuses for a job

Available options: pending, processing, waiting, completed, failed, canceled

priority · integer · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

user_id · string · required

organization_id · string · required

is_terminal · boolean · required · read-only

Whether the job has reached a terminal state and will not transition further.

Derived from :attr:JobStatus.TERMINAL_STATUSES, so adding a new terminal status to the enum automatically updates the wire field — clients that read is_terminal never need to know the status taxonomy or be re-released when it changes.

is_failed · boolean · required · read-only

Whether the job terminated unsuccessfully (failed or canceled, not completed).

Derived from :attr:is_terminal minus the success case, so any new non-success terminal status added to :class:JobStatus is automatically classified as a failure without touching this method.

started_at · string<date-time> | null

completed_at · string<date-time> | null

compute_time · number | null

error · string | null

error_code · enum<string> | null

Machine-readable error codes for jobs.

Available options: EXECUTION_TIMEOUT, SUBMISSION_FAILED

result · Result · object

callback_url · string<uri> | null

Required string length: 1 - 2083

parent_job_id · string | null

project_id · string | null

access_level · enum<string> | null · default: organization

Possible access levels for a job

Available options: project, organization

params_path · string | null

metadata_path · string | null