IOionworks
optimizations

List Optimization Runs

Changed on

List the multistart runs of an optimization in one call.

Each run carries status and convergence history (read server-side), so the frontend renders per-run progress without touching jobs.

get/optimizations/{id}/runs

Request

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

Path parameters

idstring uuid required

Response

Successful Response

run_idstring required

Opaque identifier for this optimization run.

indexinteger required

Zero-based position of the run, in creation order.

status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required

Frontend-facing lifecycle status for an async resource.

element_keystring nullable

For an array fit, the independent-variable value of the element this run belongs to, e.g. '25.0'. Null for a single fit and for runs recorded before the field existed.

start_idstring nullable

The run's multistart within its fit, from '0'. An array fit repeats it in every element, so pair it with element_key. Null for runs recorded before the field existed.

intermediate_resultsobject[] nullable

Per-iteration convergence history for the run; its length is the current iteration count. Null until the run produces history.

Changes

  • ea3d377fec1aRevision changes
    • breaking

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

  • 8ed5440390f0Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status