IOionworks
Pipeline

Cancel a pipeline

Changed on

Cancel a running pipeline and all its non-terminal elements.

post/pipelines/{pipeline_id}/cancel

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/pipelines/{pipeline_id}/cancel
  • Auth
    none declared

Path parameters

pipeline_idstring uuid required

Response

Successful Response

status'pending' | 'running' | 'completed' | 'failed' | 'canceled' required
idstring required
project_idstring required
user_idstring nullable
namestring required
descriptionstring nullable
created_atstring date-time required
updated_atstring date-time required
errorstring nullable
error_code'CONFIGURATION_ERROR' | 'MODEL_ERROR' | 'SOLVER_ERROR' | 'MAX_BACKWARD_JUMPS_EXCEEDED' | 'EXECUTION_TIMEOUT' | 'SUBMISSION_FAILED' | 'INTERNAL_ERROR'

Machine-readable error codes for jobs.

created_by_emailstring nullable
organization_idstring required

Organization this pipeline belongs to.

is_terminalboolean required

Whether the pipeline has settled and will not transition again.

is_failedboolean required

Whether the pipeline settled on anything other than success.

Derived as terminal-minus-success, so a new non-success terminal status is classified without editing this method.

Changes

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter pipeline_id, the format changed from no format to uuid

    • warning

      added the new MAX_BACKWARD_JUMPS_EXCEEDED enum value to the / response property for the response status

  • 7baccf056192Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status