Items¶

Item ¶

Bases: Entry, HasOwner, HasRevisionControl, IsCollectable, HasBlocks, HasLocation, HasFiles, ABC

The generic model for data types that will be exposed with their own named endpoints.

Item is the abstract base shared by every physical item type: samples, cells, starting materials and equipment. item_id is normally the only required field; the remaining fields are either optional metadata or bookkeeping that the server populates itself.

date ¶

date: IsoformatDateTime | None = None

A relevant 'creation' timestamp for the entry (e.g., purchase date, synthesis date).

description ¶

description: str | None = None

A description of the item, either in plain-text or a markup language.

item_id ¶

item_id: HumanReadableIdentifier

A locally unique, human-readable identifier for the entry. This ID is mutable.

name ¶

name: str | None = None

An optional human-readable/usable name for the entry.

refcode ¶

refcode: Refcode | None = None

A globally unique immutable ID comprised of the deployment prefix (e.g., grey) and a locally unique string, ideally created with some consistent scheme.

status ¶

status: str | None = None

The status of the item, with allowed values defined by the specific item class.