benchling_sdk.services.v2.beta.v2_beta_worklist_service module

class V2BetaWorklistService

Bases: benchling_sdk.services.v2.base_service.BaseService

V2-Beta Worklists.

Worklists are a convenient way to organize items for bulk actions, and are complementary to folders and projects.

See https://benchling.com/api/v2-beta/reference#/Worklists

append_item(worklist_id, worklist_item_create: benchling_api_client.v2.beta.models.worklist_item_create.WorklistItemCreate) → Union[benchling_api_client.v2.beta.models.batch.Batch, benchling_api_client.v2.beta.models.container.Container, benchling_api_client.v2.beta.models.generic_entity.GenericEntity, benchling_api_client.v2.beta.models.plate.Plate, benchling_api_client.v2.extensions.UnknownType]

Append an item to the end of a worklist if the item is not already present in the worklist.

See https://benchling.com/api/v2-beta/reference#/Worklists/createWorklistItem

create(worklist: benchling_api_client.v2.beta.models.worklist_create.WorklistCreate) → benchling_api_client.v2.beta.models.worklist.Worklist

Create a worklist.

See https://benchling.com/api/v2-beta/reference#/Worklists/createWorklist

delete(worklist_id: str) → None

Permanently deletes a worklist.

See https://benchling.com/api/v2-beta/reference#/Worklists/deleteWorklist

get_by_id(worklist_id: str) → benchling_api_client.v2.beta.models.worklist.Worklist

Get a worklist by ID.

See https://benchling.com/api/v2-beta/reference#/Worklists/getWorklist

list(*, sort: Optional[Union[str, benchling_api_client.v2.beta.models.list_worklists_sort.ListWorklistsSort]] = None, modified_at: Optional[str] = None, ids: Optional[Iterable[str]] = None, worklist_type: Optional[benchling_api_client.v2.beta.models.worklist_type.WorklistType] = None, page_size: Optional[int] = 50) → PageIterator[benchling_api_client.v2.beta.models.worklist.Worklist]

List worklists.

Individual items within a worklist are summarized.

See https://benchling.com/api/v2-beta/reference#/Worklists/listWorklists

update(worklist_id: str, worklist_update: benchling_api_client.v2.beta.models.worklist_update.WorklistUpdate) → benchling_api_client.v2.beta.models.worklist.Worklist

Update a worklist.

See https://benchling.com/api/v2-beta/reference#/Worklists/updateWorklist