IOionworks
optimizations

Get Optimization Resource

Changed on

Get a single optimization as a job-free resource.

Accepts an optimization id (or, transitionally, a job_id) and returns an :class:OptimizationResource with flat status and run count.

get/optimizations/{id}

Request

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

Path parameters

idstring uuid required

Response

Successful Response

urlstring nullable
api_urlstring nullable
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

  • 3abf50e2d741Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ea3d377fec1aRevision changes
    • breaking

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