benchling_sdk.services.v2.stable.dataset_service module

class DatasetService

Bases: benchling_sdk.services.v2.base_service.BaseService

Datasets.

Similar to Data frames, datasets in Benchling represent tabular data that is not schematized. Datasets are saved to folders within Benchling with additional metadata, making them accessible and searchable within Benchling. Each dataset actually contains a data frame, and a data frame is required to create a dataset.

See https://benchling.com/api/v2/reference#/Datasets

archive_datasets(dataset_ids: Iterable[str], reason: benchling_api_client.v2.stable.models.datasets_archive_reason.DatasetsArchiveReason) → benchling_api_client.v2.stable.models.datasets_archival_change.DatasetsArchivalChange

Archive Datasets.

See https://benchling.com/api/reference#/Datasets/archiveDatasets

create(dataset: benchling_api_client.v2.stable.models.dataset_create.DatasetCreate) → benchling_api_client.v2.stable.models.dataset.Dataset

Create a dataset.

See https://benchling.com/api/v2/reference#/Datasets/createDataset

get_by_id(dataset_id: str) → benchling_api_client.v2.stable.models.dataset.Dataset

Get a dataset.

See https://benchling.com/api/v2/reference#/Datasets/getDataset

list(*, page_size: Optional[int] = 50, sort: Optional[ListDatasetsSort] = ListDatasetsSort.MODIFIEDAT, archive_reason: Optional[str] = None, created_at: Optional[str] = None, creator_ids: Optional[str] = None, folder_id: Optional[str] = None, mentioned_in: Optional[str] = None, modified_at: Optional[str] = None, name: Optional[str] = None, name_includes: Optional[str] = None, namesany_ofcase_sensitive: Optional[str] = None, namesany_of: Optional[str] = None, origin_ids: Optional[str] = None, ids: Optional[str] = None, display_ids: Optional[str] = None, returning: Optional[str] = None) → PageIterator[benchling_api_client.v2.stable.models.dataset.Dataset]

List Datasets.

See https://benchling.com/api/v2/reference#/Datasets/listDatasets

unarchive(dataset_ids: Iterable[str]) → benchling_api_client.v2.stable.models.datasets_archival_change.DatasetsArchivalChange

Unarchive one or more Datasets.

See https://benchling.com/api/reference#/Datasets/unarchiveDatasets

update(dataset_id: str, dataset: benchling_api_client.v2.stable.models.dataset_update.DatasetUpdate) → benchling_api_client.v2.stable.models.dataset.Dataset

Update a Dataset.

See https://benchling.com/api/reference#/Datasets/updateDataset