benchling_sdk.services.v2.stable.assay_result_service module

class AssayResultService

Bases: benchling_sdk.services.v2.base_service.BaseService

Assay Results.

Results represent the output of assays that have been performed. You can customize the schemas of results to fit your needs. Results can link to runs, batches, and other types.

See https://benchling.com/api/reference#/Assay%20Results

abort_transaction(transaction_id: str) → AssayResultTransactionCreateResponse

Abort a transaction.

Aborting a transaction will discard all uploaded results.

See https://benchling.com/api/reference#/Assay%20Results/abortAssayResultsTransaction

archive(assay_result_ids: Iterable[str]) → AssayResultIdsResponse

Archive assay results.

Only results that have not been added to a Notebook Entry can be Archived. Once results are attached to a notebook entry, they are tracked in the history of that notebook entry, and cannot be archived.

See https://benchling.com/api/reference#/Assay%20Results/archiveAssayResults

bulk_get(assay_result_ids: Iterable[str]) → Optional[List[AssayResult]]

Bulk get assay results.

Up to 200 IDs can be specified at once.

See https://benchling.com/api/reference#/Assay%20Results/bulkGetAssayResults

commit_transaction(transaction_id: str) → AssayResultTransactionCreateResponse

Commit results in an active transaction.

Committing a transaction will cause all results that have been uploaded to be saved and visible to others.

See https://benchling.com/api/reference#/Assay%20Results/commitAssayResultsTransaction

create(assay_results: Iterable[AssayResultCreate]) → AssayResultsCreateResponse

Create 1 or more results.

See https://benchling.com/api/reference#/Assay%20Results/createAssayResults

create_results_in_transaction(transaction_id: str, assay_results: Iterable[AssayResultCreate]) → AssayResultsCreateResponse

Create results in a transaction.

See https://benchling.com/api/reference#/Assay%20Results/createAssayResultsInTransaction

create_transaction() → AssayResultTransactionCreateResponse

Create a transaction.

See https://benchling.com/api/reference#/Assay%20Results/createAssayResultsTransaction

get_by_id(assay_result_id: str) → AssayResult

Get a result.

See https://benchling.com/api/reference#/Assay%20Results/getAssayResult

list(schema_id: str, min_created_time: Optional[int] = None, max_created_time: Optional[int] = None, entity_ids: Optional[Iterable[str]] = None, assay_run_ids: Optional[Iterable[str]] = None, page_size: Optional[int] = None, ids: Optional[Iterable[str]] = None, storage_ids: Optional[Iterable[str]] = None, created_atgt: Optional[str] = None, created_atgte: Optional[str] = None, created_atlt: Optional[str] = None, created_atlte: Optional[str] = None, sort: Optional[Union[str, ListAssayResultsSort]] = None) → PageIterator[AssayResult]

List results.

See https://benchling.com/api/reference#/Assay%20Results/listAssayResults

transaction_manager() → TransactionManager

Create a Python context manager for adding results within a transaction.

When the context exits, the transaction manager will attempt to commit the transaction.

If an unhandled error occurs within the context, the transaction manager will automatically attempt to abort the transaction.

Returns

A Python context manager for the transaction

Return type

TransactionManager

unarchive(assay_result_ids: Iterable[str]) → AssayResultIdsResponse

Unarchive assay results.

See https://benchling.com/api/reference#/Assay%20Results/unarchiveAssayResults