benchling_sdk.services.v2.stable.registry_service module

class RegistryService

Bases: benchling_sdk.services.v2.base_service.BaseService

Registry.

Manage registry objects.

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

entities(registry_id: str, entity_registry_ids: Iterable[str]) → List[Union[DnaSequenceWithEntityType, CustomEntityWithEntityType, AaSequenceWithEntityType, MixtureWithEntityType, DnaOligoWithEntityType, RnaOligoWithEntityType, benchling_api_client.v2.extensions.UnknownType]]

Bulk get registered entities.

See https://benchling.com/api/reference#/Registry/bulkGetRegisteredEntities

get_by_id(registry_id: str) → Registry

Get registry.

See https://benchling.com/api/reference#/Registry/getRegistry

register(registry_id: str, entity_ids: Iterable[str], naming_strategy: NamingStrategy = NamingStrategy.NEW_IDS) → TaskHelper[EmptyTaskResponse]

Register entities.

Attempts to move entities into the registry. This endpoint will first check that the entities are all valid to be moved into the registry, given the namingStrategy. If any entities fail validation, no files will be moved and errors describing invalid entities is returned.

If all entities pass validation, the entities are moved into the registry.

See https://benchling.com/api/reference#/Registry/registerEntities

registries() → List[Registry]

List registries.

See https://benchling.com/api/reference#/Registry/listRegistries

Returns

A list of registries

Return type

List[Registry]

unregister(registry_id: str, entity_ids: Iterable[str], folder_id: str) → None

Unregister entities.

Unregisters entities and moves them to a folder.

See https://benchling.com/api/reference#/Registry/unregisterEntities