IOionworks
optimizations

Get Optimization Series

Changed on

One objective's validation series, windowed and budgeted.

The same rows /metadata carries whole. A plot reading them from there downloads every sample of both solves to draw a few hundred points.

get/optimizations/{id}/series

Request

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

Path parameters

idstring uuid required

Query parameters

objectivestring required

Objective name within the payload

sourcestring

Which solve: 'optimal' or 'baseline'

columnsstring nullable

Comma-separated channels besides the x column

x_columnstring nullable

Column plotted on x, and windowed on. Defaults to the objective's own x channel, which is not 'Time [s]' for every objective type.

xstring nullable

Deprecated alias for x_column, kept for one release. x_column wins when both are given.

max_pointsinteger nullable

Row ceiling, from the plot's measured width

x_minnumber nullable

Window lower bound, in x's units

x_maxnumber nullable

Window upper bound, in x's units

Response

Successful Response

unknown required

Changes

  • ea3d377fec1aRevision changes
    • breaking

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

  • 48c041ad4800Revision changes
    • breaking

      for the query request parameter x, default value Time [s] was removed

    • info

      added the new optional query request parameter x_column

    • info

      query request parameter x was deprecated

    • info

      query request parameter x list-of-types was widened by adding types null

    • info

      for the query request parameter x, the type was generalized from string to no type