IOionworks
parameterized_models

Update a parameterized model

Changed on

Update a parameterized model's name, description, settings, or symbols.

Under /cells/{cell_spec_id}/parameterized_models this reaches that cell specification's models; under /parameterized_models it reaches models with no cell specification.

patch/parameterized_models/{parameterized_model_id}

Request

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

Path parameters

parameterized_model_idstring uuid required

Query parameters

cell_spec_idstring uuid nullable

Request body

namestring nullable
descriptionstring nullable
simulation_settingsobject nullable
parameter_symbolsobject nullable

Map of parameter name to display symbol, replacing the stored overrides. A blank symbol drops that parameter's override.

Response

Successful Response

unknown required

Changes

  • abebbbc5f60aRevision changes
    • info

      added the new optional request property

  • 4185f624bbb8Revision changes
    • 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