Data API — Labware Mappings
labware_mapping_create
sync(labware_type_id: UUID, client: AuthenticatedClient | Client, body: CreateLabwareMappingRequest | Unset = UNSET) -> LabwareMappingResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
labware_type_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | CreateLabwareMappingRequest | Unset | UNSET |
- body — Request to create a labware type mapping
Returns: LabwareMappingResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
labware_mapping_delete
sync(labware_type_id: UUID, labware_mapping_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
labware_type_id | UUID | required |
labware_mapping_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
labware_mapping_describe
sync(labware_type_id: UUID, labware_mapping_id: UUID, client: AuthenticatedClient | Client) -> LabwareMappingResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
labware_type_id | UUID | required |
labware_mapping_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: LabwareMappingResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
labware_mapping_list_all
sync(client: AuthenticatedClient | Client, include: list[LabwareMappingInclude] | Unset = UNSET, has_collection: bool | Unset = UNSET, labware_mapping_collection_id: UUID | Unset = UNSET, labware_type_name: str | Unset = UNSET, collection_name: str | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[LabwareMappingResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
include | list[LabwareMappingInclude] | Unset | UNSET |
has_collection | bool | Unset | UNSET |
labware_mapping_collection_id | UUID | Unset | UNSET |
labware_type_name | str | Unset | UNSET |
collection_name | str | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[LabwareMappingResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
labware_mapping_list_for_labware_type
sync(labware_type_id: UUID, client: AuthenticatedClient | Client, include: list[LabwareMappingInclude] | Unset = UNSET, has_collection: bool | Unset = UNSET, labware_mapping_collection_id: UUID | Unset = UNSET, labware_type_name: str | Unset = UNSET, collection_name: str | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[LabwareMappingResponse] | NoneParameter | Type | Default |
|---|---|---|
labware_type_id | UUID | required |
client | AuthenticatedClient | Client | required |
include | list[LabwareMappingInclude] | Unset | UNSET |
has_collection | bool | Unset | UNSET |
labware_mapping_collection_id | UUID | Unset | UNSET |
labware_type_name | str | Unset | UNSET |
collection_name | str | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[LabwareMappingResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
labware_mapping_update
sync(labware_type_id: UUID, labware_mapping_id: UUID, client: AuthenticatedClient | Client, body: UpdateLabwareMappingRequest | Unset = UNSET) -> LabwareMappingResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
labware_type_id | UUID | required |
labware_mapping_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | UpdateLabwareMappingRequest | Unset | UNSET |
- body — Request to create a labware type mapping
Returns: LabwareMappingResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |