IOionworks
Cell Batches

Update a cell batch

Changed on

Update a batch's name, notes, manufacture date or properties.

Parameters

batch_id : str Batch to update. body : UpdateCellBatchBody Fields to change. Omitted fields are left alone; an explicit null clears notes, date_manufactured or properties.

Returns

CellBatch The updated batch.

patch/cell_batches/{batch_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/cell_batches/{batch_id}
  • Auth
    none declared

Path parameters

batch_idstring uuid required

Request body

namestring nullable

New lot name

notesstring nullable

New notes

date_manufacturedstring date nullable

New manufacture date

propertiesobject nullable

New lot metadata

Response

Successful Response

idstring required

Unique identifier for the batch

organization_idstring required

ID of the organization that owns this batch

project_idstring required

ID of the project that owns this batch

cell_specification_idstring required

Cell specification this batch is a production run of

namestring required

Lot name or number, unique (case-insensitively) per specification

notesstring nullable

Free-text notes about the batch

date_manufacturedstring date nullable

Manufacture date of the batch

propertiesobject nullable

Free-form lot metadata (datasheet lot number, QC results). Numeric values use the Quantity format.

created_bystring nullable

User ID of the user who created this batch

created_atstring date-time required

When the batch was created

updated_atstring date-time required

When the batch was last updated

instance_countinteger

Number of cell instances filed under this batch

Changes