curl --request GET \
--url https://api.ionworks.com/simulationsimport requests
url = "https://api.ionworks.com/simulations"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/simulations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/simulations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simulations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/simulations")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simulations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"simulations": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"experiment_id": "<string>",
"parameterized_model_id": "<string>",
"organization_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"project_id": "<string>",
"design_id": "<string>",
"job_id": "<string>",
"status": "<string>",
"error": "<string>",
"error_code": "<string>",
"metrics": {},
"simulation_options": {},
"storage_folder": "<string>",
"experiment": {},
"parameterized_model": {},
"design": {},
"protocol_id": "<string>",
"protocol_name": "<string>"
}
],
"model_scalar_parameters": {},
"total": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}List Simulations
List simulations filtered by a parameterized model, study, protocol, or project.
Scope by exactly one of parameterized_model_id, study_id or
project_id, or by experiment_template_id alone.
experiment_template_id may also be combined with any of the other three
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, study_id or project_id.
project_id : str, optional
List every simulation in this project, however it was started.
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 : , 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.
cell_spec_id : str, optional
Filter expression on the cell specification of the run’s parameterized
model, e.g. "eq.<id>" or "in.(<id>,<id>)".
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.
curl --request GET \
--url https://api.ionworks.com/simulationsimport requests
url = "https://api.ionworks.com/simulations"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/simulations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ionworks.com/simulations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/simulations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/simulations")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/simulations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"simulations": [
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"experiment_id": "<string>",
"parameterized_model_id": "<string>",
"organization_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"project_id": "<string>",
"design_id": "<string>",
"job_id": "<string>",
"status": "<string>",
"error": "<string>",
"error_code": "<string>",
"metrics": {},
"simulation_options": {},
"storage_folder": "<string>",
"experiment": {},
"parameterized_model": {},
"design": {},
"protocol_id": "<string>",
"protocol_name": "<string>"
}
],
"model_scalar_parameters": {},
"total": 0
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Query Parameters
Response
Successful Response
Response for study simulations with deduplicated model parameters.
Instead of including full parameters on each simulation (which can be massive expression trees), this response includes simulations without parameters and a separate map of model_id -> scalar parameters. The frontend can merge: design.design_parameters over model base params.
Was this page helpful?