IOionworks
Cell Specifications

Update a cell specification with nested component/material data

Changed on

Update an existing cell specification with nested component and material data.

Materials and components are automatically upserted based on uniqueness. Only provided fields will be updated.

Example request body:

{
    "capacity": 0.003,
    "anode": {
        "properties": {"diameter_mm": 16, "thickness_um": 25},
        "material": {"name": "Graphite", "manufacturer": "NewSupplier"}
    }
}
patch/cell_specifications/{cell_spec_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/cell_specifications/{cell_spec_id}
  • Auth
    none declared

Path parameters

cell_spec_idstring uuid required

Request body

namestring nullable

New name of the cell specification

form_factorstring nullable

New form factor

manufacturerstring nullable

New manufacturer

propertiesobject nullable

New cell-level properties

sourceobject nullable

New source/provenance info

default_parameterized_model_idstring nullable

Set the default parameterized model for this specification. Must reference one of this specification's own parameterized models. Pass null to clear the default.

notesstring nullable

Notes

Response

Successful Response

namestring required

Name of the cell specification

form_factorstring nullable

Physical form factor. Common values: '18650', '21700', 'R2032' (coin cell), 'pouch', 'prismatic', 'cylindrical'.

manufacturerstring nullable

Who assembled/manufactured the cell

anode_idstring nullable

ID of the anode component

cathode_idstring nullable

ID of the cathode component

electrolyte_idstring nullable

ID of the electrolyte component

separator_idstring nullable

ID of the separator component

case_idstring nullable

ID of the case component

propertiesobject nullable

Other design-level properties that are not electrical ratings and not tied to a specific component — e.g. assembly method, overall cell dimensions, mass, target thickness. Numeric values must use the Quantity format ({'value': ..., 'unit': ...}).

sourceobject nullable

Provenance of the design. Typical keys: 'doi', 'citation', 'publication_date' (ISO 8601), 'license', 'creator_name', 'creator_orcid'. Lives on the specification (not the instance) because it describes the published design.

notesstring nullable

Free-text notes about the cell specification

idstring required

Unique identifier for the cell specification

organization_idstring required

Organization ID of the cell specification

project_idstring required

Project this cell specification belongs to

created_atstring date-time nullable

When this specification was created

updated_atstring date-time nullable

When this specification was last modified

created_bystring nullable

User ID of the user who created this specification

created_by_emailstring nullable

Email of the user who created this specification

instance_idsobject[] nullable

List of instance IDs associated with the cell specification

default_parameterized_model_idstring nullable

ID of the parameterized model marked as this specification's default model, or None if unset.

cad_file_pathstring nullable

Storage path of the attached CAD model, if any.

cad_file_namestring nullable

Original filename of the attached CAD model.

cad_thumbnail_pathstring nullable

Storage path of the rendered CAD thumbnail; None when no model is attached or the model could not be rendered.

cad_thumbnail_urlstring nullable

Signed URL of the CAD thumbnail. Only set on list responses that pass include=thumbnail_url.

Changes

  • 6fbec094b30eRevision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • 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

    • 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

    • 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 1f50d4b61910Revision 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