Sign in

Update a model within an organization

Update a model, validating it belongs to the organization.

patch/models/{model_id}

Path parameters

model_idstring required

Request body

namestring nullable

The new name of the model.

descriptionstring nullable

The new optional description for the model.

pybamm_versionstring nullable

Updated PyBaMM version used for this model.

chemistry'lithium_ion' | 'lithium_sulfur' | 'ecm' | 'generic' nullable

Updated model chemistry kind.

simulation_settingsobject nullable

Updated persistent simulation kwargs (mesh + solver).

Response

Successful Response

namestring required

The name of the model.

descriptionstring nullable

An optional description for the model.

pybamm_versionstring nullable

PyBaMM version used for this model. If not provided, will be read from pybamm.version.

chemistry'lithium_ion' | 'lithium_sulfur' | 'ecm' | 'generic'

Model chemistry kind: 'lithium_ion' (default — assumes pybamm lithium-ion conventions), 'lithium_sulfur', 'ecm', or 'generic' (no chemistry-specific enrichment).

simulation_settingsobject nullable

Optional persistent simulation kwargs (var_pts / submesh_types / spatial_methods / geometry / solver) in the flat canonical form, re-applied at simulation time. None uses the model defaults.

idstring required

The unique identifier for the model.

user_idstring required

The ID of the user who created the model.

organization_idstring required

The ID of the organization this model belongs to.

created_by_emailstring nullable

Email of the user who created the model.

created_atstring date-time required

Timestamp of when the model was created.

updated_atstring date-time required

Timestamp of when the model was last updated.

is_custom_modelboolean required

Check if this is a custom model (has compressed model data).

Changes