IOionworks
parameterized_models

Create a parameterized model for a cell specification or project

Changed on

Create a parameterized model, under a cell specification or in a project.

Via /cells/{cell_spec_id}/parameterized_models the model belongs to that cell specification, whose capacity and voltage cut-offs override the parameter set's. Via /parameterized_models with project_id in the body it has no cell specification and keeps the parameter set's own values.

Raises

BadRequestError If neither scope is given, or project_id names a different project than the cell specification's. NotFoundError If the cell specification, project, or model cannot be read.

post/parameterized_models

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/parameterized_models
  • Auth
    none declared

Query parameters

cell_spec_idstring uuid nullable

Request body

namestring required
descriptionstring
model_idstring required
parametersobject
simulation_settingsobject nullable
parameter_symbolsobject nullable

Map of parameter name to display symbol, overriding the defaults; a clone carries its source's.

project_idstring uuid nullable

Project for a model with no cell specification; under one, it must match the specification's project.

Response

Successful Response

unknown required

Changes

  • abebbbc5f60aRevision changes
    • info

      added the new optional request property

  • 4185f624bbb8Revision changes
    • info

      added the new optional request property

    • info

      the query request parameter cell_spec_id became optional

    • info

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

    • info

      for the query request parameter cell_spec_id, the type was generalized from string to no type, and format from uuid to no format