IOionworks
Simulations

Get Simulation

Changed on
get/simulations/{simulation_id}

Request

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

Path parameters

simulation_idstring uuid required

Response

Successful Response

urlstring nullable
api_urlstring nullable
idstring required

The unique identifier for the simulation.

created_atstring date-time required

Timestamp of when the simulation was created.

updated_atstring date-time nullable

Timestamp of when the simulation was last updated.

experiment_idstring required

The ID of the experiment this simulation belongs to.

project_idstring nullable

The project the simulation belongs to: its experiment's project.

parameterized_model_idstring required

The ID of the parameterized model used for this simulation.

design_idstring nullable

The ID of the design for this simulation.

job_idstring nullable

The ID of the job running this simulation.

statusstring nullable

The current status of the job running this simulation.

errorstring nullable

Error message if the job failed.

error_codestring nullable

Machine-readable error code.

metricsobject nullable

Computed metrics from the simulation.

simulation_optionsobject nullable

Options the simulation was run with; part of its identity, so a rerun must send them back.

storage_folderstring nullable

Folder path in storage containing simulation files (solution.parquet, time_series.parquet, steps.parquet).

organization_idstring required

Organization this simulation belongs to.

experimentobject nullable

The experiment this simulation belongs to (id and template).

parameterized_modelobject nullable

The parameterized model (id and name only).

designobject nullable

The design used for this simulation.

protocol_idstring nullable

The saved protocol (experiment template) the simulation ran; the same id the run and list endpoints take as a protocol.

protocol_namestring nullable

That protocol's name.

parametersobject nullable

Resolved parameters for the simulation.

simulation_dataobject nullable

The data from the simulation (time_series, steps).

Changes

  • 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 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

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter simulation_id, the format changed from no format to uuid