Confirm a signed URL upload and finalize the measurement

Confirm a signed URL upload and finalize the measurement.

Confirm a signed URL upload and finalize the measurement

cURL

curl --request POST \
  --url https://api.ionworks.com/cell_measurements/{measurement_id}/confirm-upload \
  --header 'Content-Type: application/json' \
  --data '
{
  "cell_instance_id": "<string>",
  "measurement": {},
  "measurement_type": "time_series",
  "steps": {},
  "filenames": [
    "<string>"
  ]
}
'

200

{
  "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",
  "instance": {
    "name": "<string>",
    "id": "<string>",
    "cell_specification_id": "<string>",
    "organization_id": "<string>",
    "project_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "batch": "<string>",
    "date_manufactured": "2023-11-07T05:31:56Z",
    "measured_properties": {},
    "notes": "<string>",
    "created_by": "<string>",
    "created_by_email": "<string>",
    "measurement_ids": [
      {}
    ]
  },
  "steps_created": 123,
  "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>"
}

Path Parameters

measurement_id · string · required

Body

application/json

Request model for confirming a signed URL upload.

cell_instance_id · string · required

Parent cell instance ID

measurement · Measurement · object · required

Measurement data with custom fields

measurement_type · enum<string> · default: time_series

Type of measurement being confirmed.

Available options: time_series, file, properties

steps · Steps · object

Optional steps. Auto-calculated from time series if omitted

filenames · string[] | null

Filenames that were uploaded (for file-type measurements). When provided, skips the slow storage listing verification.

Response

200

application/json

Successful Response

Flat response after confirming a signed URL upload.

Measurement fields (id, name, measurement_type, etc.) are at the top level, alongside the parent instance and upload metadata.

name · string · required

Required string length: 1 - 255

id · 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

instance · CellInstance · object · required

Model representing a cell instance as returned by the API.

Show child attributes

steps_created · integer · 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

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: 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'.