benchling_sdk.services.v2.stable.dropdown_service module¶

class DropdownService¶

Bases: benchling_sdk.services.v2.base_service.BaseService

Dropdowns.

Dropdowns are registry-wide enums. Use dropdowns to standardize on spelling and naming conventions, especially for important metadata like resistance markers.

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

archive_options(dropdown_id: str, dropdown_option_ids: Iterable[str], reason: DropdownOptionsArchiveReason) → DropdownOptionsArchivalChange¶

Archive dropdown options.

See https://benchling.com/api/reference#/Dropdowns/archiveDropdownOptions

create(dropdown: DropdownCreate) → Dropdown¶

Create a dropdown.

See https://benchling.com/api/reference#/Dropdowns/createDropdown

get_by_id(dropdown_id: str) → Dropdown¶

Get a dropdown.

See https://benchling.com/api/reference#/Dropdowns/getDropdown

list(*, page_size: Optional[int] = 50) → PageIterator[DropdownSummary]¶

List dropdowns.

See https://benchling.com/api/reference#/Dropdowns/listDropdowns

unarchive_options(dropdown_id: str, dropdown_option_ids: Iterable[str]) → DropdownOptionsArchivalChange¶

Unarchive dropdown options.

See https://benchling.com/api/reference#/Dropdowns/unarchiveDropdownOptions

update(dropdown_id: str, dropdown: DropdownUpdate) → Dropdown¶

Update a dropdown.

See https://benchling.com/api/reference#/Dropdowns/updateDropdown