IOionworks
Cell Instances

Update a specific cell instance by id

Changed on

Updates an existing cell instance identified by its ID. Only provided fields will be updated.

patch/cell_instances/{cell_instance_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/cell_instances/{cell_instance_id}
  • Auth
    none declared

Path parameters

cell_instance_idstring uuid required

Request body

object required

Response

Successful Response

is_failedboolean

Whether it was reported as failed.

failure_reasonstring nullable

Why it failed.

failed_atstring date-time nullable

When it was reported.

failed_bystring nullable

User who reported it.

namestring required

Name of the cell instance (serial number)

batch_idstring uuid nullable

Manufacturing lot (cell batch) this cell came from. Must be a batch of the same cell specification.

date_manufacturedstring date nullable

Date of manufacture

measured_propertiesobject nullable

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.

notesstring nullable

Free-text notes about the cell instance

idstring required

Unique identifier for the cell instance

cell_specification_idstring required

Foreign key to the cell specification

organization_idstring required

Organization this cell instance belongs to.

project_idstring required

Project this cell instance belongs to

created_bystring nullable

User ID of the user who created this instance

created_by_emailstring nullable

Email of the user who created this instance

created_atstring date-time required

Timestamp when the instance was created

updated_atstring date-time required

Timestamp when the instance was last updated

batch_namestring nullable

Name of the batch batch_id points at. Read-only.

measurement_idsobject[] nullable

List of measurement IDs associated with the cell instance

Changes

  • f4c74e855466Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1f50d4b61910Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status