benchling_sdk.services.v2.stable.workflow_task_group_service module

class WorkflowTaskGroupService

Bases: benchling_sdk.services.v2.base_service.BaseService

Workflow Task Groups.

Workflow task groups are groups of workflow tasks of the same schema.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups

archive(workflow_task_group_ids: Iterable[str], reason: WorkflowTaskGroupArchiveReason) → WorkflowTaskGroupsArchivalChange

Archive one or more workflows.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups/archiveWorkflowTaskGroups

create(workflow_task_group: WorkflowTaskGroupCreate) → WorkflowTaskGroup

Create a new workflow task group.

If no name is specified, uses the workflow schema name and a unique incrementor separated by a single whitespace.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups/createWorkflowTaskGroup

get_by_id(workflow_task_group_id: str) → WorkflowTaskGroup

Get a workflow task group.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups/getWorkflowTaskGroup

list(ids: Optional[Iterable[str]] = None, schema_id: Optional[str] = None, folder_id: Optional[str] = None, project_id: Optional[str] = None, mentioned_in: Optional[Iterable[str]] = None, watcher_ids: Optional[Iterable[str]] = None, execution_types: Optional[Iterable[str]] = None, responsible_team_ids: Optional[Iterable[str]] = None, status_ids_any_of: Optional[Iterable[str]] = None, status_ids_none_of: Optional[Iterable[str]] = None, status_ids_only: Optional[Iterable[str]] = None, name: Optional[str] = None, name_includes: Optional[str] = None, creator_ids: Optional[Iterable[str]] = None, modified_at: Optional[str] = None, display_ids: Optional[Iterable[str]] = None, archive_reason: Optional[str] = None, page_size: Optional[int] = None) → PageIterator[WorkflowTaskGroup]

List workflow task groups.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups/listWorkflowTaskGroups

unarchive(workflow_task_group_ids: Iterable[str]) → WorkflowTaskGroupsArchivalChange

Unarchive one or more workflows.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups/unarchiveWorkflowTaskGroups

update(workflow_task_group_id: str, workflow_task_group: WorkflowTaskGroupUpdate) → WorkflowTaskGroup

Update a workflow task group.

See https://benchling.com/api/reference#/Workflow%20Task%20Groups/updateWorkflowTaskGroup