benchling_sdk.services.v2.stable.entry_service module

class EntryService

Bases: benchling_sdk.services.v2.base_service.BaseService

Entries.

Entries are rich text documents that allow you to capture all of your experimental data in one place.

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

archive_entries(entry_ids: Iterable[str], reason: EntriesArchiveReason) → EntriesArchivalChange

Archive notebook entries.

See https://benchling.com/api/reference#/Entries/archiveEntries

bulk_get_entries(entry_ids: Optional[Iterable[str]] = None, display_ids: Optional[Iterable[str]] = None, returning: Optional[Iterable[str]] = None) → Optional[List[Entry]]

Bulk get notebook entries.

See https://benchling.com/api/reference#/Entries/bulkGetEntries

create_entry(entry: EntryCreate) → Entry

Create a notebook entry.

See https://benchling.com/api/reference#/Entries/createEntry

get_entry_by_id(entry_id: str, returning: Optional[Iterable[str]] = None) → Entry

Get a notebook entry by ID.

See https://benchling.com/api/reference#/Entries/getEntry

get_entry_template_by_id(entry_template_id: str, returning: Optional[Iterable[str]] = None) → EntryTemplate

Get a notebook template entry by ID.

See https://benchling.com/api/reference#/Entries/getTemplateEntry

get_external_file(entry_id: str, external_file_id: str) → EntryExternalFile

Retrieve the metadata for an external file.

Use the download_url to download the actual file.

See https://benchling.com/api/reference#/Entries/getExternalFileMetadata

list_entries(*, sort: Optional[Union[str, ListEntriesSort]] = None, modified_at: Optional[str] = None, name: Optional[str] = None, project_id: Optional[str] = None, archive_reason: Optional[str] = None, review_status: Optional[ListEntriesReviewStatus] = None, mentioned_in: Optional[str] = None, mentions: Optional[str] = None, ids: 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, display_ids: Optional[Iterable[str]] = None, assigned_reviewer_ids_any_of: Optional[Iterable[str]] = None, schema_id: Optional[str] = None, page_size: Optional[int] = 50, author_idsany_of: Optional[Iterable[str]] = None, returning: Optional[Iterable[str]] = None) → PageIterator[Entry]

List notebook entries.

See https://benchling.com/api/reference#/Entries/listEntries

list_entry_templates(*, modified_at: Optional[str] = None, name: Optional[str] = None, template_collection_id: Optional[str] = None, ids: Optional[Iterable[str]] = None, schema_id: Optional[str] = None, page_size: Optional[int] = 50, returning: Optional[Iterable[str]] = None) → PageIterator[EntryTemplate]

List entry templates.

See https://benchling.com/api/reference#/Entries/listEntryTemplates

unarchive_entries(entry_ids: Iterable[str]) → EntriesArchivalChange

Unarchive notebook entries.

See https://benchling.com/api/reference#/Entries/unarchiveEntries

update_entry(entry_id: str, entry: EntryUpdate, returning: Optional[Iterable[str]] = None) → Entry

Update a notebook entry’s metadata.

See https://benchling.com/api/reference#/Entries/updateEntry

update_entry_template(entry_template_id: str, entry_template: EntryTemplateUpdate, returning: Optional[Iterable[str]] = None) → EntryTemplate

Update a notebook entry template’s metadata.

See https://benchling.com/api/reference#/Entries/updateEntryTemplate