Update a cell measurement by id

Update an existing cell measurement’s metadata.

Only metadata fields can be updated (name, protocol, test_setup, notes, properties). Time series and steps data cannot be modified.

Update a cell measurement by id

cURL

curl --request PATCH \
  --url https://api.ionworks.com/cell_measurements/{measurement_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "protocol": {},
  "test_setup": {},
  "notes": "<string>",
  "properties": {}
}
'

200

{
  "name": "<string>",
  "id": "<string>",
  "cell_instance_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "protocol": {},
  "start_time": "2023-11-07T05:31:56Z",
  "test_setup": {},
  "step_labels_validated": false,
  "notes": "<string>",
  "measurement_type": "time_series",
  "properties": {},
  "file_metadata": {},
  "organization_id": "<string>",
  "created_by": "<string>",
  "created_by_email": "<string>"
}

Path Parameters

measurement_id · string · required

Body

application/json

Model for updating an existing cell measurement. All fields optional.

name · string | null

Required string length: 1 - 255

protocol · Protocol · object

Protocol information as a dict with: name (str), ambient_temperature_degc (float), definition (dict | str - UCP or other protocol format)

test_setup · Test Setup · object

Test setup: cycler, operator, lab, etc.

notes · string | null

properties · Properties · object

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

Response

200

application/json

Successful Response

name · string · required

Required string length: 1 - 255

id · string · required

cell_instance_id · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

protocol · Protocol · object

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.

test_setup · Test Setup · object

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

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

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

organization_id · string | null

Organization this measurement belongs to.

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