benchling_sdk.services.v2.stable.custom_entity_service module

class CustomEntityService

Bases: benchling_sdk.services.v2.base_service.BaseService

Custom Entities.

Benchling supports custom entities for biological entities that are neither sequences or proteins. Custom entities must have an entity schema set and can have both schema fields and custom fields.

See https://benchling.com/api/reference#/Custom%20Entities

archive(entity_ids: Iterable[str], reason: EntityArchiveReason) → CustomEntitiesArchivalChange

Archive custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/archiveCustomEntities

bulk_create(entities: Iterable[CustomEntityBulkCreate]) → TaskHelper[BulkCreateCustomEntitiesAsyncTaskResponse]

Bulk create custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/bulkCreateCustomEntities

bulk_get(entity_ids: Iterable[str], returning: Optional[Iterable[str]] = None) → Optional[List[CustomEntity]]

Bulk get custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/bulkGetCustomEntities

bulk_update(entities: Iterable[CustomEntityBulkUpdate]) → TaskHelper[BulkUpdateCustomEntitiesAsyncTaskResponse]

Bulk update custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/bulkUpdateCustomEntities

bulk_upsert(body: CustomEntitiesBulkUpsertRequest) → TaskHelper[BulkUpdateCustomEntitiesAsyncTaskResponse]

Bulk update custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/bulkUpsertCustomEntities

create(entity: CustomEntityCreate) → CustomEntity

Create a custom entity.

See https://benchling.com/api/reference#/Custom%20Entities/createCustomEntity

get_by_id(entity_id: str, returning: Optional[Iterable[str]] = None) → CustomEntity

Get a custom entity.

See https://benchling.com/api/reference#/Custom%20Entities/getCustomEntity

list(schema_id: Optional[str] = None, modified_at: Optional[str] = None, name: Optional[str] = None, name_includes: Optional[str] = None, folder_id: Optional[str] = None, mentioned_in: Optional[List[str]] = None, project_id: Optional[str] = None, registry_id: Optional[str] = None, archive_reason: Optional[str] = None, mentions: Optional[List[str]] = None, ids: Optional[Iterable[str]] = None, entity_registry_ids_any_of: 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, schema_fields: Optional[Dict[str, Any]] = None, sort: Optional[Union[str, ListCustomEntitiesSort]] = None, page_size: Optional[int] = None, author_idsany_of: Optional[Iterable[str]] = None, returning: Optional[Iterable[str]] = None) → PageIterator[CustomEntity]

List custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/listCustomEntities

unarchive(entity_ids: Iterable[str]) → CustomEntitiesArchivalChange

Unarchive custom entities.

See https://benchling.com/api/reference#/Custom%20Entities/unarchiveCustomEntities

update(entity_id: str, entity: CustomEntityUpdate) → CustomEntity

Update a custom entity.

See https://benchling.com/api/reference#/Custom%20Entities/updateCustomEntity

upsert(entity_registry_id: str, entity: CustomEntityUpsertRequest) → CustomEntity

Create or modify a custom entity.

See https://benchling.com/api/reference#/Custom%20Entities/upsertCustomEntity