IOionworks
parameterized_models

Create a new version of a parameterized model

Changed on

Save a copy of a parameterized model with some parameters changed.

Parameters cannot be edited in place, so this is how a model is revised: the new version starts from the parent's parameters with parameters applied on top, and records the parent it came from. The parent is left unchanged, so simulations that ran on it still point at the parameters they used. Scoped like :func:update_parameterized_model.

summary=true returns metadata without parameter values or model config.

post/parameterized_models/{parameterized_model_id}/versions

Request

Path parameters

parameterized_model_idstring uuid required

Query parameters

cell_spec_idstring uuid nullable
summaryboolean

Request body

descriptionstring nullable

Description of the new version. Defaults to the parent's.

parametersobject

Parameter values that differ from the parent's, keyed by parameter name. Parameters not listed keep the parent's value.

simulation_settingsobject nullable

Simulation settings for the new version. Defaults to the parent's.

Response

Successful Response

unknown required

Changes