IOionworks
simple_pipeline

Update SimplePipeline name/description

Changed on

Partially update a SimplePipeline's name and/or description.

Deprecated: use PATCH /pipelines/{pipeline_id}.

patch/simple_pipelines/{simple_pipeline_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/simple_pipelines/{simple_pipeline_id}
  • Auth
    none declared

Path parameters

simple_pipeline_idstring uuid required

Request body

namestring nullable
descriptionstring nullable

Response

Successful Response

status'pending' | 'running' | 'completed' | 'failed' | 'canceled' required
idstring required
project_idstring required
organization_idstring required
user_idstring nullable
namestring nullable
descriptionstring nullable
job_idstring 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
config_pathstring required
resultobject nullable
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

  • d3e6ef342a9dRevision changes
    • info

      endpoint deprecated

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter simple_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