Create a planned measurement
curl --request POST \
--url https://api.ionworks.com/projects/{project_id}/planned_measurements \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cell_specification_id": "<string>",
"cell_instance_id": "<string>",
"channel_id": "<string>",
"set_temperature_c": 123,
"thermal_chamber_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"test_setup": {},
"planned_start_time": "2023-11-07T05:31:56Z",
"planned_end_time": "2023-11-07T05:31:56Z",
"estimated_duration_seconds": 2,
"setup_duration_seconds": 0,
"teardown_duration_seconds": 0,
"notes": "<string>",
"status": "requested"
}
'import requests
url = "https://api.ionworks.com/projects/{project_id}/planned_measurements"
payload = {
"name": "<string>",
"cell_specification_id": "<string>",
"cell_instance_id": "<string>",
"channel_id": "<string>",
"set_temperature_c": 123,
"thermal_chamber_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"test_setup": {},
"planned_start_time": "2023-11-07T05:31:56Z",
"planned_end_time": "2023-11-07T05:31:56Z",
"estimated_duration_seconds": 2,
"setup_duration_seconds": 0,
"teardown_duration_seconds": 0,
"notes": "<string>",
"status": "requested"
}
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>',
cell_specification_id: '<string>',
cell_instance_id: '<string>',
channel_id: '<string>',
set_temperature_c: 123,
thermal_chamber_id: '<string>',
protocol_id: '<string>',
program_id: '<string>',
test_setup: {},
planned_start_time: '2023-11-07T05:31:56Z',
planned_end_time: '2023-11-07T05:31:56Z',
estimated_duration_seconds: 2,
setup_duration_seconds: 0,
teardown_duration_seconds: 0,
notes: '<string>',
status: 'requested'
})
};
fetch('https://api.ionworks.com/projects/{project_id}/planned_measurements', 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/projects/{project_id}/planned_measurements",
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>',
'cell_specification_id' => '<string>',
'cell_instance_id' => '<string>',
'channel_id' => '<string>',
'set_temperature_c' => 123,
'thermal_chamber_id' => '<string>',
'protocol_id' => '<string>',
'program_id' => '<string>',
'test_setup' => [
],
'planned_start_time' => '2023-11-07T05:31:56Z',
'planned_end_time' => '2023-11-07T05:31:56Z',
'estimated_duration_seconds' => 2,
'setup_duration_seconds' => 0,
'teardown_duration_seconds' => 0,
'notes' => '<string>',
'status' => 'requested'
]),
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/projects/{project_id}/planned_measurements"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cell_specification_id\": \"<string>\",\n \"cell_instance_id\": \"<string>\",\n \"channel_id\": \"<string>\",\n \"set_temperature_c\": 123,\n \"thermal_chamber_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"test_setup\": {},\n \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_duration_seconds\": 2,\n \"setup_duration_seconds\": 0,\n \"teardown_duration_seconds\": 0,\n \"notes\": \"<string>\",\n \"status\": \"requested\"\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/projects/{project_id}/planned_measurements")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cell_specification_id\": \"<string>\",\n \"cell_instance_id\": \"<string>\",\n \"channel_id\": \"<string>\",\n \"set_temperature_c\": 123,\n \"thermal_chamber_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"test_setup\": {},\n \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_duration_seconds\": 2,\n \"setup_duration_seconds\": 0,\n \"teardown_duration_seconds\": 0,\n \"notes\": \"<string>\",\n \"status\": \"requested\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/projects/{project_id}/planned_measurements")
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 \"cell_specification_id\": \"<string>\",\n \"cell_instance_id\": \"<string>\",\n \"channel_id\": \"<string>\",\n \"set_temperature_c\": 123,\n \"thermal_chamber_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"test_setup\": {},\n \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_duration_seconds\": 2,\n \"setup_duration_seconds\": 0,\n \"teardown_duration_seconds\": 0,\n \"notes\": \"<string>\",\n \"status\": \"requested\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"status": "requested",
"requested_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"cell_specification_id": "<string>",
"cell_instance_id": "<string>",
"channel_id": "<string>",
"set_temperature_c": 123,
"thermal_chamber_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"test_setup": {},
"planned_start_time": "2023-11-07T05:31:56Z",
"planned_end_time": "2023-11-07T05:31:56Z",
"estimated_duration_seconds": 2,
"setup_duration_seconds": 0,
"teardown_duration_seconds": 0,
"notes": "<string>",
"scheduled_by": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_measurement_id": "<string>",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancelled_by": "<string>",
"cancellation_reason": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"requested_by_email": "<string>",
"cancelled_by_email": "<string>",
"scheduled_by_email": "<string>",
"channel_name": "<string>",
"cycler_id": "<string>",
"cycler_name": "<string>",
"program_name": "<string>",
"estimated_duration_status": "estimating",
"estimated_duration_job_id": "<string>",
"estimated_duration_simulation_id": "<string>",
"simulated_duration_seconds": 123,
"estimated_duration_is_exact": true,
"estimated_duration_margin_pct": 123,
"actual_duration_seconds": 123,
"estimated_duration_note": "<string>",
"estimated_duration_calculated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Planned Measurements
Create a planned measurement
Create a requested or scheduled planned measurement.
Create a planned measurement
curl --request POST \
--url https://api.ionworks.com/projects/{project_id}/planned_measurements \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cell_specification_id": "<string>",
"cell_instance_id": "<string>",
"channel_id": "<string>",
"set_temperature_c": 123,
"thermal_chamber_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"test_setup": {},
"planned_start_time": "2023-11-07T05:31:56Z",
"planned_end_time": "2023-11-07T05:31:56Z",
"estimated_duration_seconds": 2,
"setup_duration_seconds": 0,
"teardown_duration_seconds": 0,
"notes": "<string>",
"status": "requested"
}
'import requests
url = "https://api.ionworks.com/projects/{project_id}/planned_measurements"
payload = {
"name": "<string>",
"cell_specification_id": "<string>",
"cell_instance_id": "<string>",
"channel_id": "<string>",
"set_temperature_c": 123,
"thermal_chamber_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"test_setup": {},
"planned_start_time": "2023-11-07T05:31:56Z",
"planned_end_time": "2023-11-07T05:31:56Z",
"estimated_duration_seconds": 2,
"setup_duration_seconds": 0,
"teardown_duration_seconds": 0,
"notes": "<string>",
"status": "requested"
}
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>',
cell_specification_id: '<string>',
cell_instance_id: '<string>',
channel_id: '<string>',
set_temperature_c: 123,
thermal_chamber_id: '<string>',
protocol_id: '<string>',
program_id: '<string>',
test_setup: {},
planned_start_time: '2023-11-07T05:31:56Z',
planned_end_time: '2023-11-07T05:31:56Z',
estimated_duration_seconds: 2,
setup_duration_seconds: 0,
teardown_duration_seconds: 0,
notes: '<string>',
status: 'requested'
})
};
fetch('https://api.ionworks.com/projects/{project_id}/planned_measurements', 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/projects/{project_id}/planned_measurements",
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>',
'cell_specification_id' => '<string>',
'cell_instance_id' => '<string>',
'channel_id' => '<string>',
'set_temperature_c' => 123,
'thermal_chamber_id' => '<string>',
'protocol_id' => '<string>',
'program_id' => '<string>',
'test_setup' => [
],
'planned_start_time' => '2023-11-07T05:31:56Z',
'planned_end_time' => '2023-11-07T05:31:56Z',
'estimated_duration_seconds' => 2,
'setup_duration_seconds' => 0,
'teardown_duration_seconds' => 0,
'notes' => '<string>',
'status' => 'requested'
]),
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/projects/{project_id}/planned_measurements"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cell_specification_id\": \"<string>\",\n \"cell_instance_id\": \"<string>\",\n \"channel_id\": \"<string>\",\n \"set_temperature_c\": 123,\n \"thermal_chamber_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"test_setup\": {},\n \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_duration_seconds\": 2,\n \"setup_duration_seconds\": 0,\n \"teardown_duration_seconds\": 0,\n \"notes\": \"<string>\",\n \"status\": \"requested\"\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/projects/{project_id}/planned_measurements")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cell_specification_id\": \"<string>\",\n \"cell_instance_id\": \"<string>\",\n \"channel_id\": \"<string>\",\n \"set_temperature_c\": 123,\n \"thermal_chamber_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"test_setup\": {},\n \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_duration_seconds\": 2,\n \"setup_duration_seconds\": 0,\n \"teardown_duration_seconds\": 0,\n \"notes\": \"<string>\",\n \"status\": \"requested\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/projects/{project_id}/planned_measurements")
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 \"cell_specification_id\": \"<string>\",\n \"cell_instance_id\": \"<string>\",\n \"channel_id\": \"<string>\",\n \"set_temperature_c\": 123,\n \"thermal_chamber_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"test_setup\": {},\n \"planned_start_time\": \"2023-11-07T05:31:56Z\",\n \"planned_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_duration_seconds\": 2,\n \"setup_duration_seconds\": 0,\n \"teardown_duration_seconds\": 0,\n \"notes\": \"<string>\",\n \"status\": \"requested\"\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"status": "requested",
"requested_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"cell_specification_id": "<string>",
"cell_instance_id": "<string>",
"channel_id": "<string>",
"set_temperature_c": 123,
"thermal_chamber_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"test_setup": {},
"planned_start_time": "2023-11-07T05:31:56Z",
"planned_end_time": "2023-11-07T05:31:56Z",
"estimated_duration_seconds": 2,
"setup_duration_seconds": 0,
"teardown_duration_seconds": 0,
"notes": "<string>",
"scheduled_by": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_measurement_id": "<string>",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancelled_by": "<string>",
"cancellation_reason": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"requested_by_email": "<string>",
"cancelled_by_email": "<string>",
"scheduled_by_email": "<string>",
"channel_name": "<string>",
"cycler_id": "<string>",
"cycler_name": "<string>",
"program_name": "<string>",
"estimated_duration_status": "estimating",
"estimated_duration_job_id": "<string>",
"estimated_duration_simulation_id": "<string>",
"simulated_duration_seconds": 123,
"estimated_duration_is_exact": true,
"estimated_duration_margin_pct": 123,
"actual_duration_seconds": 123,
"estimated_duration_note": "<string>",
"estimated_duration_calculated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Request model for creating a planned measurement.
Response
Successful Response
A planned measurement row returned by the API.
Lifecycle of a duration estimate computed by a background simulation.
Used by both estimates: a planned test's total duration
(planned_measurements.estimated_duration_*) and a running test's
remaining duration (cell_measurements.estimated_end_time_*). One enum
because the lifecycle is identical -- only what is being estimated differs.
estimating while the job is in flight, ready once a value came from
it, failed with the reason in the accompanying note. None means no
estimate was ever requested.
Available options:
estimating, ready, failed Was this page helpful?