Simulations

List Simulations

Changed on

List simulations filtered by a parameterized model, study, or protocol.

Scope by exactly one of parameterized_model_id or study_id, or by experiment_template_id alone. experiment_template_id may also be combined with either of the other two to narrow it to one protocol, which is how a client finds the existing runs of one model on one protocol. Returns simulation summaries without simulation_data, plus a map of model scalar parameters deduplicated by parameterized_model_id.

Parameters

parameterized_model_id : str, optional Filter simulations belonging to this parameterized model. study_id : str, optional Filter simulations assigned to this study. experiment_template_id : str, optional Filter simulations whose experiment references this protocol template. Combines with parameterized_model_id or study_id. limit : int, optional Maximum number of results to return. Must be between 1 and 1000. Defaults to 100. offset : int, optional Number of results to skip for pagination. Must be >= 0. Defaults to 0. status : str, optional PostgREST filter expression on the simulation's job status, e.g. "eq.completed" or "in.(pending,processing,waiting)". When provided, only simulations whose job matches are returned. state : {"queued", "running", "completed", "failed"}, optional The same filter by coarse state: queued is pending or waiting, failed includes canceled. Give at most one of status and state. model_name, protocol_name : str, optional Exact-match expressions (e.g. "eq.My model") on the joined parameterized model name and protocol (experiment template) name. A simulation has no name of its own, so these two are what identify it. created_at_gt, created_at_lt, updated_at_gt, updated_at_lt : str, optional ISO datetime strings for date-range (between) filtering on the native created_at / updated_at columns. summary : bool, optional Leave out each run's metrics and storage_folder, and the model scalar parameter map, so a listing stays small. Defaults to False.

Returns

ListSimulationsResponse Simulations, model scalar parameters map, and total count.

get/simulations

Request

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

Query parameters

parameterized_model_idstring uuid nullable
study_idstring uuid nullable
experiment_template_idstring uuid nullable
limitinteger
offsetinteger
statusstring nullable
state'queued' | 'running' | 'completed' | 'failed' nullable
model_namestring nullable
protocol_namestring nullable
created_at_gtstring nullable
created_at_ltstring nullable
updated_at_gtstring nullable
updated_at_ltstring nullable
summaryboolean

Response

Successful Response

model_scalar_parametersobject

Map of parameterized_model_id to scalar-only parameters. Used as fallback when design.design_parameters doesn't have a value.

totalinteger

Total number of matching simulations.

Changes

    • info

      added the new optional query request parameter state

    • info

      added the new optional query request parameter summary

    • 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