curl --request POST \
--url https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"properties": {},
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "properties",
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create"
payload = {
"name": "<string>",
"properties": {},
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "properties",
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": ["<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>',
properties: {},
protocol: {},
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
estimated_end_time: '2023-11-07T05:31:56Z',
estimated_end_time_note: '<string>',
estimated_end_time_calculated_at: '2023-11-07T05:31:56Z',
test_setup: {},
notes: '<string>',
measurement_type: 'properties',
file_metadata: {},
channel_id: '<string>',
protocol_id: '<string>',
program_id: '<string>',
tags: ['<string>']
})
};
fetch('https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create', 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/cell_instances/{cell_instance_id}/cell_measurements/create",
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>',
'properties' => [
],
'protocol' => [
],
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'estimated_end_time' => '2023-11-07T05:31:56Z',
'estimated_end_time_note' => '<string>',
'estimated_end_time_calculated_at' => '2023-11-07T05:31:56Z',
'test_setup' => [
],
'notes' => '<string>',
'measurement_type' => 'properties',
'file_metadata' => [
],
'channel_id' => '<string>',
'protocol_id' => '<string>',
'program_id' => '<string>',
'tags' => [
'<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/cell_instances/{cell_instance_id}/cell_measurements/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"properties\": {},\n \"protocol\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time_note\": \"<string>\",\n \"estimated_end_time_calculated_at\": \"2023-11-07T05:31:56Z\",\n \"test_setup\": {},\n \"notes\": \"<string>\",\n \"measurement_type\": \"properties\",\n \"file_metadata\": {},\n \"channel_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\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/cell_instances/{cell_instance_id}/cell_measurements/create")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"properties\": {},\n \"protocol\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time_note\": \"<string>\",\n \"estimated_end_time_calculated_at\": \"2023-11-07T05:31:56Z\",\n \"test_setup\": {},\n \"notes\": \"<string>\",\n \"measurement_type\": \"properties\",\n \"file_metadata\": {},\n \"channel_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create")
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 \"properties\": {},\n \"protocol\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time_note\": \"<string>\",\n \"estimated_end_time_calculated_at\": \"2023-11-07T05:31:56Z\",\n \"test_setup\": {},\n \"notes\": \"<string>\",\n \"measurement_type\": \"properties\",\n \"file_metadata\": {},\n \"channel_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"cell_instance_id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_failed": false,
"failure_reason": "<string>",
"failed_at": "2023-11-07T05:31:56Z",
"failed_by": "<string>",
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "time_series",
"properties": {},
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": [
"<string>"
],
"created_by": "<string>",
"created_by_email": "<string>",
"processing_status": "ready",
"processing_error": "<string>",
"source_etag": "<string>",
"row_count": 123,
"time_series_bytes": 123,
"recorded_duration_s": 123,
"accepts_raw_updates": false,
"estimated_end_time_status": "estimating",
"estimated_end_time_job_id": "<string>",
"extend_claim_id": "<string>",
"extend_in_progress_at": "2023-11-07T05:31:56Z",
"extend_claimed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create a properties-type measurement directly
Create a properties-type measurement without the upload flow.
Use this for manual measurements like thickness, weight, etc.
curl --request POST \
--url https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"properties": {},
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "properties",
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create"
payload = {
"name": "<string>",
"properties": {},
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "properties",
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": ["<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>',
properties: {},
protocol: {},
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
estimated_end_time: '2023-11-07T05:31:56Z',
estimated_end_time_note: '<string>',
estimated_end_time_calculated_at: '2023-11-07T05:31:56Z',
test_setup: {},
notes: '<string>',
measurement_type: 'properties',
file_metadata: {},
channel_id: '<string>',
protocol_id: '<string>',
program_id: '<string>',
tags: ['<string>']
})
};
fetch('https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create', 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/cell_instances/{cell_instance_id}/cell_measurements/create",
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>',
'properties' => [
],
'protocol' => [
],
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'estimated_end_time' => '2023-11-07T05:31:56Z',
'estimated_end_time_note' => '<string>',
'estimated_end_time_calculated_at' => '2023-11-07T05:31:56Z',
'test_setup' => [
],
'notes' => '<string>',
'measurement_type' => 'properties',
'file_metadata' => [
],
'channel_id' => '<string>',
'protocol_id' => '<string>',
'program_id' => '<string>',
'tags' => [
'<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/cell_instances/{cell_instance_id}/cell_measurements/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"properties\": {},\n \"protocol\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time_note\": \"<string>\",\n \"estimated_end_time_calculated_at\": \"2023-11-07T05:31:56Z\",\n \"test_setup\": {},\n \"notes\": \"<string>\",\n \"measurement_type\": \"properties\",\n \"file_metadata\": {},\n \"channel_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\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/cell_instances/{cell_instance_id}/cell_measurements/create")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"properties\": {},\n \"protocol\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time_note\": \"<string>\",\n \"estimated_end_time_calculated_at\": \"2023-11-07T05:31:56Z\",\n \"test_setup\": {},\n \"notes\": \"<string>\",\n \"measurement_type\": \"properties\",\n \"file_metadata\": {},\n \"channel_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/cell_instances/{cell_instance_id}/cell_measurements/create")
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 \"properties\": {},\n \"protocol\": {},\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time\": \"2023-11-07T05:31:56Z\",\n \"estimated_end_time_note\": \"<string>\",\n \"estimated_end_time_calculated_at\": \"2023-11-07T05:31:56Z\",\n \"test_setup\": {},\n \"notes\": \"<string>\",\n \"measurement_type\": \"properties\",\n \"file_metadata\": {},\n \"channel_id\": \"<string>\",\n \"protocol_id\": \"<string>\",\n \"program_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"id": "<string>",
"cell_instance_id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_failed": false,
"failure_reason": "<string>",
"failed_at": "2023-11-07T05:31:56Z",
"failed_by": "<string>",
"protocol": {},
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"estimated_end_time": "2023-11-07T05:31:56Z",
"estimated_end_time_note": "<string>",
"estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
"test_setup": {},
"notes": "<string>",
"measurement_type": "time_series",
"properties": {},
"file_metadata": {},
"channel_id": "<string>",
"protocol_id": "<string>",
"program_id": "<string>",
"tags": [
"<string>"
],
"created_by": "<string>",
"created_by_email": "<string>",
"processing_status": "ready",
"processing_error": "<string>",
"source_etag": "<string>",
"row_count": 123,
"time_series_bytes": 123,
"recorded_duration_s": 123,
"accepts_raw_updates": false,
"estimated_end_time_status": "estimating",
"estimated_end_time_job_id": "<string>",
"extend_claim_id": "<string>",
"extend_in_progress_at": "2023-11-07T05:31:56Z",
"extend_claimed_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
Request model for creating a properties-type measurement directly (no upload).
Inherits field validation (including validate_properties) from
CellMeasurementBase. Overrides measurement_type default and
makes properties required.
Physical test setup. Typical keys: 'cycler' (model), 'operator', 'lab', 'channel_number'. Readers also record what the cycler header carries, drawn from one shared vocabulary so the shape does not vary by cycler: 'test_name', 'cell_label' (the cycler's own label for the cell, which need not match the cell instance), 'instrument', 'cycler_serial_number', 'software_version', 'temperature_setpoint_degc', 'notes', 'end_time', plus export provenance -- 'export_date', 'source_file_path', 'barcode_comment', and 'source_file_id' (an id in the cycler's own id space, not a cross-system identifier). Which of these a file can fill depends on its format; keys the header does not carry are omitted rather than set empty.
Response
Successful Response
Physical test setup. Typical keys: 'cycler' (model), 'operator', 'lab', 'channel_number'. Readers also record what the cycler header carries, drawn from one shared vocabulary so the shape does not vary by cycler: 'test_name', 'cell_label' (the cycler's own label for the cell, which need not match the cell instance), 'instrument', 'cycler_serial_number', 'software_version', 'temperature_setpoint_degc', 'notes', 'end_time', plus export provenance -- 'export_date', 'source_file_path', 'barcode_comment', and 'source_file_id' (an id in the cycler's own id space, not a cross-system identifier). Which of these a file can fill depends on its format; keys the header does not carry are omitted rather than set empty.
Lifecycle of server-side step processing. 'ready' once steps are available; 'pending'/'running' while the upload is being processed asynchronously; 'failed' if processing failed (see processing_error).
pending, running, ready, failed, awaiting_extend, extending 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.
estimating, ready, failed Was this page helpful?