Create a properties-type measurement directly

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": {},
  "step_labels_validated": false,
  "notes": "<string>",
  "measurement_type": "properties",
  "file_metadata": {},
  "channel_id": "<string>",
  "program_id": "<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": {},
    "step_labels_validated": False,
    "notes": "<string>",
    "measurement_type": "properties",
    "file_metadata": {},
    "channel_id": "<string>",
    "program_id": "<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: {},
    step_labels_validated: false,
    notes: '<string>',
    measurement_type: 'properties',
    file_metadata: {},
    channel_id: '<string>',
    program_id: '<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' => [
        
    ],
    'step_labels_validated' => false,
    'notes' => '<string>',
    'measurement_type' => 'properties',
    'file_metadata' => [
        
    ],
    'channel_id' => '<string>',
    'program_id' => '<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  \"step_labels_validated\": false,\n  \"notes\": \"<string>\",\n  \"measurement_type\": \"properties\",\n  \"file_metadata\": {},\n  \"channel_id\": \"<string>\",\n  \"program_id\": \"<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/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  \"step_labels_validated\": false,\n  \"notes\": \"<string>\",\n  \"measurement_type\": \"properties\",\n  \"file_metadata\": {},\n  \"channel_id\": \"<string>\",\n  \"program_id\": \"<string>\"\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  \"step_labels_validated\": false,\n  \"notes\": \"<string>\",\n  \"measurement_type\": \"properties\",\n  \"file_metadata\": {},\n  \"channel_id\": \"<string>\",\n  \"program_id\": \"<string>\"\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",
  "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": {},
  "step_labels_validated": false,
  "notes": "<string>",
  "measurement_type": "time_series",
  "properties": {},
  "file_metadata": {},
  "channel_id": "<string>",
  "program_id": "<string>",
  "created_by": "<string>",
  "created_by_email": "<string>",
  "processing_status": "ready",
  "processing_error": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Create a properties-type measurement directly

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": {},
  "step_labels_validated": false,
  "notes": "<string>",
  "measurement_type": "properties",
  "file_metadata": {},
  "channel_id": "<string>",
  "program_id": "<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": {},
    "step_labels_validated": False,
    "notes": "<string>",
    "measurement_type": "properties",
    "file_metadata": {},
    "channel_id": "<string>",
    "program_id": "<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: {},
    step_labels_validated: false,
    notes: '<string>',
    measurement_type: 'properties',
    file_metadata: {},
    channel_id: '<string>',
    program_id: '<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' => [
        
    ],
    'step_labels_validated' => false,
    'notes' => '<string>',
    'measurement_type' => 'properties',
    'file_metadata' => [
        
    ],
    'channel_id' => '<string>',
    'program_id' => '<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  \"step_labels_validated\": false,\n  \"notes\": \"<string>\",\n  \"measurement_type\": \"properties\",\n  \"file_metadata\": {},\n  \"channel_id\": \"<string>\",\n  \"program_id\": \"<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/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  \"step_labels_validated\": false,\n  \"notes\": \"<string>\",\n  \"measurement_type\": \"properties\",\n  \"file_metadata\": {},\n  \"channel_id\": \"<string>\",\n  \"program_id\": \"<string>\"\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  \"step_labels_validated\": false,\n  \"notes\": \"<string>\",\n  \"measurement_type\": \"properties\",\n  \"file_metadata\": {},\n  \"channel_id\": \"<string>\",\n  \"program_id\": \"<string>\"\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",
  "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": {},
  "step_labels_validated": false,
  "notes": "<string>",
  "measurement_type": "time_series",
  "properties": {},
  "file_metadata": {},
  "channel_id": "<string>",
  "program_id": "<string>",
  "created_by": "<string>",
  "created_by_email": "<string>",
  "processing_status": "ready",
  "processing_error": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

cell_instance_id

string

required

Body

application/json

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.

name

string

required

Required string length: 1 - 255

properties

Properties · object

required

Key-value measurements using Quantity format for numerics. Example: {'thickness': {'value': 0.52, 'unit': 'mm'}}

protocol

Protocol · object | null

Protocol information. Typical keys: 'name' (str), 'ambient_temperature_degc' (float), 'definition' (dict | str — a UCP protocol definition or another protocol format).

start_time

string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) marking when the test started.

end_time

string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) marking when the test finished. Leave null while the test is still running; set it once the measurement is complete. A null end_time means the cell is still considered 'on test' in the Lab view.

estimated_end_time

string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) forecasting when a still-running test will finish. Distinct from end_time (the actual finish): this is an estimate. Null when no estimate has been computed yet.

estimated_end_time_note

string | null

Free-text explanation of how estimated_end_time was derived.

estimated_end_time_calculated_at

string<date-time> | null

ISO 8601 datetime with timezone marking when estimated_end_time was last computed.

test_setup

Test Setup · object | null

Physical test setup. Typical keys: 'cycler' (model), 'operator', 'lab', 'channel_number' (int).

step_labels_validated

boolean

default:false

Set to true only once step-type labels (Rest, CC charge, CV, discharge, etc.) have been manually reviewed. Server-inferred labels should leave this false.

notes

string | null

Free-text notes about the cell measurement

measurement_type

enum<string>

default:properties

Must be 'properties' for this endpoint.

Available options:

time_series,

file,

properties

file_metadata

File Metadata · object | null

Metadata about uploaded files (MIME types, dimensions, etc.)

channel_id

string | null

Optional ID of the channel this measurement ran on.

program_id

string | null

Optional catalog program for this measurement (copied from a linked planned measurement when present).

Response

Successful Response

name

string

required

Required string length: 1 - 255

string

required

cell_instance_id

string

required

organization_id

string

required

Organization this measurement belongs to.

project_id

string

required

Project this measurement belongs to

created_at

string<date-time>

required

updated_at

string<date-time>

required

protocol

Protocol · object | null

Protocol information. Typical keys: 'name' (str), 'ambient_temperature_degc' (float), 'definition' (dict | str — a UCP protocol definition or another protocol format).

start_time

string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) marking when the test started.

end_time

string<date-time> | null

estimated_end_time

string<date-time> | null

estimated_end_time_note

string | null

Free-text explanation of how estimated_end_time was derived.

estimated_end_time_calculated_at

string<date-time> | null

ISO 8601 datetime with timezone marking when estimated_end_time was last computed.

test_setup

Test Setup · object | null

Physical test setup. Typical keys: 'cycler' (model), 'operator', 'lab', 'channel_number' (int).

step_labels_validated

boolean

default:false

Set to true only once step-type labels (Rest, CC charge, CV, discharge, etc.) have been manually reviewed. Server-inferred labels should leave this false.

notes

string | null

Free-text notes about the cell measurement

measurement_type

enum<string>

default:time_series

What shape of data this measurement holds. Determines which fields are populated and which upload flow applies. See the class docstring.

Available options:

time_series,

file,

properties

properties

Properties · object | null

Flat key/value measurements, populated only when measurement_type is 'properties'. Numeric values use the Quantity format. Example: {'thickness': {'value': 0.52, 'unit': 'mm'}, 'DCIR': {'value': 12, 'unit': 'mohm'}}.

file_metadata

File Metadata · object | null

Metadata about uploaded files (MIME types, dimensions, etc.)

channel_id

string | null

Optional ID of the channel this measurement ran on.

program_id

string | null

Optional catalog program for this measurement (copied from a linked planned measurement when present).

created_by

string | null

User ID of the user who created this measurement

created_by_email

string | null

Email of the user who created this measurement

processing_status

enum<string>

default:ready

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).

Available options:

pending,

running,

ready,

failed

processing_error

string | null

Reason step processing failed, when processing_status is 'failed'.

List cell measurements for a cell instance Initiate a signed URL upload for measurement data

⌘I

API Reference

Cell Specifications

Cell Instances

Cell Measurements

Programs

Sites

Cyclers

Channels

Simulations

parameterized_models

discovery

Pipeline

simple_pipeline

protocols

users

jobs

optimization

optimizations

Organizations

studies

Lab

Planned Measurements

Health check

Create a properties-type measurement directly

Path Parameters

Body

Response