Sign in
simple_pipeline

Update SimplePipeline name/description

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

patch/simple_pipelines/{simple_pipeline_id}

Path parameters

simple_pipeline_idstring required

Request body

namestring nullable
descriptionstring nullable

Response

Successful Response

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

Machine-readable error codes for jobs.

created_by_emailstring nullable
config_pathstring required
resultobject nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.