IOionworks
parameterized_models

Get a parameterized model by id

Changed on

Get a single parameterized model (with its model info) by id.

Lets clients fetch one model directly instead of listing every model in a project. Access is scoped by row-level security via the requesting user's client.

get/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

Response

Successful Response

urlstring nullable
api_urlstring nullable
modelobject required

Model info with id and name (loaded from models table via join).

parametersobject required

Model parameters.

simulation_settingsobject nullable

Optional parameter-specific simulation kwargs.

idstring required

Unique identifier for the parameterized model.

namestring required

Human-readable name of the parameterized model.

descriptionstring nullable

Optional description of the parameterized model.

cell_spec_idstring nullable

Associated cell specification ID.

project_idstring required

Owning project ID, denormalized from the cell specification for models that have one, and supplied directly by the caller for quick models that do not.

organization_idstring required

Owning organization ID.

created_atstring date-time nullable

When the parameterized model was created.

updated_atstring date-time nullable

When the parameterized model was last updated.

created_bystring nullable

User ID of the creator.

source_model_builder_idstring nullable

Model builder that produced these parameters.

build_provenanceobject nullable

Builder config snapshot and resolved cell-spec hash it ran on.

parameter_symbolsobject nullable

Display symbols overriding the defaults, by parameter name.

Changes

  • abebbbc5f60aRevision changes
    • info

      added the optional property to the response with the status

  • 3abf50e2d741Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status