Add a custom variable to an existing model
curl --request POST \
--url https://api.ionworks.com/models/{model_id}/custom-variables \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"expression": "<string>"
}
'import requests
url = "https://api.ionworks.com/models/{model_id}/custom-variables"
payload = {
"name": "<string>",
"expression": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', expression: '<string>'})
};
fetch('https://api.ionworks.com/models/{model_id}/custom-variables', 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/models/{model_id}/custom-variables",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'expression' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/models/{model_id}/custom-variables"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"expression\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/models/{model_id}/custom-variables")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"expression\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/models/{model_id}/custom-variables")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"expression\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"config": {},
"is_custom_model": true,
"description": "<string>",
"pybamm_version": "<string>",
"chemistry": "lithium_ion",
"simulation_settings": {},
"project_id": "<string>",
"user_id": "<string>",
"source_model_id": "<string>",
"created_by_email": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}API Reference
Add a custom variable to an existing model
Append a new custom variable to a model’s config (append-only).
Validates the expression, serializes it to JSON, and stores it. Custom variables cannot be edited or deleted after creation because evaluated values are persisted in simulation result files.
Add a custom variable to an existing model
curl --request POST \
--url https://api.ionworks.com/models/{model_id}/custom-variables \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"expression": "<string>"
}
'import requests
url = "https://api.ionworks.com/models/{model_id}/custom-variables"
payload = {
"name": "<string>",
"expression": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', expression: '<string>'})
};
fetch('https://api.ionworks.com/models/{model_id}/custom-variables', 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/models/{model_id}/custom-variables",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'expression' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/models/{model_id}/custom-variables"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"expression\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ionworks.com/models/{model_id}/custom-variables")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"expression\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/models/{model_id}/custom-variables")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"expression\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"organization_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"config": {},
"is_custom_model": true,
"description": "<string>",
"pybamm_version": "<string>",
"chemistry": "lithium_ion",
"simulation_settings": {},
"project_id": "<string>",
"user_id": "<string>",
"source_model_id": "<string>",
"created_by_email": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Response
Successful Response
Model with config loaded from database.
Was this page helpful?