benchling_sdk.services.v2.stable.container_service module¶

class ContainerService¶

Bases: benchling_sdk.services.v2.base_service.BaseService

Containers.

Containers are the backbone of sample management in Benchling. They represent physical containers, such as tubes or wells, that hold quantities of biological samples (represented by the batches inside the container). The container itself tracks its total volume, and the concentration of every batch inside of it.

Containers are all associated with schemas, which define the type of the container (e.g. “Tube”) along with the fields that are tracked.

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

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

archive(container_ids: Iterable[str], reason: ContainersArchiveReason, should_remove_barcodes: bool) → ContainersArchivalChange¶

Archive containers.

See https://benchling.com/api/reference#/Containers/archiveContainers

bulk_create(containers: Iterable[ContainerCreate]) → AsyncTaskLink¶

Bulk create containers.

See https://benchling.com/api/reference#/Containers/bulkCreateContainers

bulk_get(*, container_ids: Optional[Iterable[str]] = None, barcodes: Optional[Iterable[str]] = None) → Optional[List[Container]]¶

Bulk get containers.

See https://benchling.com/api/reference#/Containers/bulkGetContainers

bulk_update(containers: Iterable[ContainerBulkUpdateItem]) → AsyncTaskLink¶

Bulk update containers.

See https://benchling.com/api/reference#/Containers/bulkUpdateContainers

checkin(checkin: ContainersCheckin) → None¶

Check in containers.

See https://benchling.com/api/reference#/Containers/checkinContainers

checkout(checkout: ContainersCheckout) → None¶

Check out containers.

See https://benchling.com/api/reference#/Containers/checkoutContainers

contents_by_id(container_id: str, containable_id: str) → ContainerContent¶

Get a container content.

See https://benchling.com/api/reference#/Containers/getContainerContent

create(container: ContainerCreate) → Container¶

Create a new container.

See https://benchling.com/api/reference#/Containers/createContainer

delete_contents(container_id: str, containable_id: str) → None¶

Delete a container’s content.

See https://benchling.com/api/reference#/Containers/deleteContainerContent

get_by_id(container_id: str) → Container¶

Get a container by ID.

See https://benchling.com/api/reference#/Containers/getContainer

list(*, sort: Optional[Union[str, ListContainersSort]] = 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, checkout_status: Optional[ListContainersCheckoutStatus] = 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) → PageIterator[Container]¶