IOionworks
simple_pipeline

Create and submit a SimplePipeline

Changed on

Create a new SimplePipeline and submit it for processing.

Deprecated: use POST /pipelines, which accepts the same elements.

post/simple_pipelines

Request

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

Request body

project_idstring required

Project ID to associate the pipeline with

namestring nullable

Optional human-readable name for the pipeline

descriptionstring nullable

Optional human-readable description for the pipeline

configobject required

Pipeline configuration with elements dict. At most one datafit/validation element, any number of cheap elements.

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