benchling_sdk.services.v2.stable.schema_service module¶

class SchemaService¶

Bases: benchling_sdk.services.v2.base_service.BaseService

Schemas.

Schemas represent custom configuration of objects in Benchling. See https://docs.benchling.com/docs/schemas in our documentation on how Schemas impact our developers.

See API docs at https://benchling.com/api/reference#/Schemas

get_assay_result_schema_by_id(schema_id: str) → AssayResultSchema¶

Get a Result schema by ID.

See https://benchling.com/api/reference#/Schemas/getResultSchema

get_assay_run_schema_by_id(schema_id: str) → AssayRunSchema¶

Get a Run schema by ID.

See https://benchling.com/api/reference#/Schemas/getRunSchema

get_batch_schemas_by_id(schema_id: str) → BatchSchema¶

Get a batch schema by ID.

See https://benchling.com/api/reference#/Schemas/getBatchSchema

get_box_schema_by_id(schema_id: str) → BoxSchema¶

Get a box schema by ID.

See https://benchling.com/api/reference#/Schemas/getBoxSchema

get_container_schema_by_id(schema_id: str) → ContainerSchema¶

Get a container schema by ID.

See https://benchling.com/api/reference#/Schemas/getContainerSchema

get_entity_schema_by_id(schema_id: str) → EntitySchema¶

Get an entity schema by ID.

See https://benchling.com/api/reference#/Schemas/getEntitySchema

get_entry_schema_by_id(schema_id: str) → EntrySchemaDetailed¶

Get an Entry schema by ID.

See https://benchling.com/api/reference#/Schemas/getEntrySchema

get_location_schema_by_id(schema_id: str) → LocationSchema¶

Get a location schema by ID.

See https://benchling.com/api/reference#/Schemas/getLocationSchema

get_plate_schema_by_id(schema_id: str) → PlateSchema¶

Get a plate schema by ID.

See https://benchling.com/api/reference#/Schemas/getPlateSchema

get_request_schema_by_id(schema_id: str) → RequestSchema¶

Get a Request schema by ID.

See https://benchling.com/api/reference#/Schemas/getRequestSchema

get_request_task_schema_by_id(schema_id: str) → RequestTaskSchema¶

Get a Request Task schema by ID.

See https://benchling.com/api/reference#/Schemas/getRequestTaskSchema

get_workflow_task_schema_by_id(schema_id: str) → WorkflowTaskSchema¶

Get a Workflow Task schema by ID.

See https://benchling.com/api/reference#/Schemas/getWorkflowTaskSchema

list_assay_result_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[AssayResultSchema]¶

List assay result schemas.

See https://benchling.com/api/reference#/Schemas/listAssayResultSchemas

list_assay_run_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[AssayRunSchema]¶

List assay run schemas.

See https://benchling.com/api/reference#/Schemas/listAssayRunSchemas

list_batch_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[BatchSchema]¶

List batch schemas.

See https://benchling.com/api/reference#/Schemas/listBatchSchemas

list_box_schemas(*, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[BoxSchema]¶

List box schemas.

See https://benchling.com/api/reference#/Schemas/listBoxSchemas

list_container_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[ContainerSchema]¶

List container schemas.

See https://benchling.com/api/reference#/Schemas/listContainerSchemas

list_entity_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[EntitySchema]¶

List entity schemas.

See https://benchling.com/api/reference#/Schemas/listEntitySchemas

list_entry_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[EntrySchemaDetailed]¶

List Entry schemas.

See https://benchling.com/api/reference#/Schemas/listEntrySchemas

list_location_schemas(*, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[LocationSchema]¶

List location schemas.

See https://benchling.com/api/reference#/Schemas/listLocationSchemas

list_plate_schemas(*, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[PlateSchema]¶

List plate schemas.

See https://benchling.com/api/reference#/Schemas/listPlateSchemas

list_request_schemas(*, registry_id: Optional[str] = None, modified_at: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[RequestSchema]¶

List Request schemas.

See https://benchling.com/api/reference#/Schemas/listRequestSchemas

list_request_task_schemas(*, modified_at: Optional[str] = None, registry_id: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[RequestTaskSchema]¶

List Request Task schemas.

See https://benchling.com/api/reference#/Schemas/listRequestTaskSchemas

list_workflow_task_schemas(*, modified_at: Optional[str] = None, page_size: Optional[int] = 50) → PageIterator[WorkflowTaskSchema]¶

List Workflow Task schemas.

See https://benchling.com/api/reference#/Schemas/listWorkflowTaskSchemas