IOionworks
optimizations

Cancel Optimization

Changed on

Cancel an optimization and return the refreshed resource.

post/optimizations/{id}/cancel

Request

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

Path parameters

idstring uuid required

Response

Successful Response

idstring required

Canonical optimization identifier.

namestring nullable
descriptionstring nullable
project_idstring required
organization_idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled'

Frontend-facing lifecycle status for an async resource.

kindstring nullable

Optimization kind discriminator (e.g. 'optimize', 'datafit'); determines how the config is interpreted.

created_atstring date-time nullable
created_by_emailstring nullable
cell_spec_idstring nullable
parameterized_model_idstring nullable
parameterized_model_namestring nullable

Display name of the parameterized model.

cell_namestring nullable

Display name of the cell specification.

optimization_template_idstring nullable
metricsobject nullable

Result metrics of the optimization, when complete.

objectivesobject nullable

Objectives/constraints from the config, for list display. Populated on list responses only.

errorstring nullable

Error message if the run failed.

error_codestring nullable

Machine-readable error code.

run_countinteger

Number of multistart runs.

Changes