Get a specific cell instance by id

Retrieves a specific cell instance by its ID.

Get a specific cell instance by id

cURL

curl --request GET \
  --url https://api.ionworks.com/cell_instances/{cell_instance_id}

200

{
  "name": "<string>",
  "id": "<string>",
  "cell_specification_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>",
  "organization_id": "<string>",
  "created_by": "<string>",
  "created_by_email": "<string>",
  "measurement_ids": [
    {}
  ]
}

Path Parameters

cell_instance_id · string · required

Response

200

application/json

Successful Response

Model representing a cell instance as returned by the API.

name · string · required

Name of the cell instance (serial number)

id · string · required

Unique identifier for the cell instance

cell_specification_id · string · required

Foreign key to the cell specification

created_at · string<date-time> · required

Timestamp when the instance was created

updated_at · string<date-time> · required

Timestamp when the instance was last updated

batch · string | null

Batch number/identifier

date_manufactured · string<date-time> | null

Date of manufacture

measured_properties · Measured Properties · object

Measured (not designed) properties of this specific cell, grouped by component. Numeric values use the Quantity format. Example: {'cathode': {'loading': {'value': 7.06, 'unit': 'mg/cm**2'}}, 'cell': {'initial_capacity': {'value': 1.08, 'unit': 'A*h'}}}. Designed properties (target loading, rated capacity) belong on the cell specification.

notes · string | null

Free-text notes about the cell instance

organization_id · string | null

Organization this cell instance belongs to.

created_by · string | null

User ID of the user who created this instance

created_by_email · string | null

Email of the user who created this instance

measurement_ids · Measurement Ids · object[] | null

List of measurement IDs associated with the cell instance