benchling_sdk.services.v2.stable.plate_service module

class PlateService

Bases: benchling_sdk.services.v2.base_service.BaseService

Plates.

Plates are a structured storage type, grids of wells that each function like containers. Plates come in two types: a traditional “fixed” type, where the wells cannot move, and a “matrix” type. A matrix plate has similar functionality to a box, where the containers inside can be moved around and removed altogether.

Plates are all associated with schemas, which define the type of the plate (e.g. “96 Well Plate”) along with the fields that are tracked, the dimensions of the plate, and whether or not the plate is a matrix plate or a traditional well plate.

Like all storage, every Plate has a barcode that is unique across the registry.

See https://benchling.com/api/reference#/Plates

archive(plate_ids: Iterable[str], reason: PlatesArchiveReason, should_remove_barcodes: bool) → PlatesArchivalChange

Archive Plates.

See https://benchling.com/api/reference#/Plates/archivePlates

bulk_get(*, plate_ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None, timeout_seconds: Optional[float] = DEFAULT_PLATE_HTTP_TIMEOUT, returning: Optional[Iterable[str]] = None) → Optional[List[Plate]]

Bulk get Plates.

Bulk Get operations on large plates may take much longer than normal. The timeout_seconds parameter will use a higher HTTP timeout than the regular default. Pass a float to override it or pass None to use the standard client default.

See https://benchling.com/api/reference#/Plates/bulkGetPlates

create(plate: PlateCreate, returning: Optional[Iterable[str]] = None) → Plate

Create a Plate.

See https://benchling.com/api/reference#/Plates/createPlate

get_by_id(plate_id: str, returning: Optional[Iterable[str]] = None) → Plate

Get a Plate by ID.

See https://benchling.com/api/reference#/Plates/getPlate

list(*, sort: Optional[Union[str, ListPlatesSort]] = None, schema_id: Optional[str] = None, modified_at: Optional[str] = None, name: Optional[str] = None, name_includes: Optional[str] = None, ancestor_storage_id: Optional[str] = None, storage_contents_id: Optional[str] = None, storage_contents_ids: Optional[List[str]] = None, ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None, names_any_of: Optional[Iterable[str]] = None, names_any_of_case_sensitive: Optional[Iterable[str]] = None, creator_ids: Optional[Iterable[str]] = None, archive_reason: Optional[str] = None, schema_fields: Optional[Dict[str, Any]] = None, page_size: Optional[int] = None, timeout_seconds: Optional[float] = DEFAULT_PLATE_HTTP_TIMEOUT, returning: Optional[Iterable[str]] = None) → PageIterator[Plate]

List Plates.

List operations on large plates may take much longer than normal. The timeout_seconds parameter will use a higher HTTP timeout than the regular default. Pass a float to override it or pass None to use the standard client default.

See https://benchling.com/api/reference#/Plates/listPlates

unarchive(plate_ids: Iterable[str]) → PlatesArchivalChange

Unarchive Plates.

See https://benchling.com/api/reference#/Plates/unarchivePlates

update(plate_id: str, plate: PlateUpdate, returning: Optional[Iterable[str]] = None) → Plate

Update a Plate.

See https://benchling.com/api/reference#/Plates/updatePlate