Data API — Labware Types

10 min

labware_type_by_id

sync(id: UUID, client: AuthenticatedClient | Client) -> LabwareTypeResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: LabwareTypeResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	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_type_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	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_type_list

sync(client: AuthenticatedClient | Client, id: UUID | Unset = UNSET, name: str | Unset = UNSET, labware_type_class: list[str] | Unset = UNSET, density: list[int] | Unset = UNSET, include: list[LabwareTypeInclude] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET, labware_mapping_name: str | Unset = UNSET, labware_mapping_collection_name: str | Unset = UNSET, sort: list[LabwareTypeSort] | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[LabwareTypeListResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
id	UUID \| Unset	UNSET
name	str \| Unset	UNSET
labware_type_class	list[str] \| Unset	UNSET
density	list[int] \| Unset	UNSET
include	list[LabwareTypeInclude] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET
labware_mapping_name	str \| Unset	UNSET
labware_mapping_collection_name	str \| Unset	UNSET
sort	list[LabwareTypeSort] \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[LabwareTypeListResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	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_type_update

sync(id: UUID, client: AuthenticatedClient | Client, body: LabwareTypeRequest | Unset = UNSET) -> LabwareTypeResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	LabwareTypeRequest \| Unset	UNSET

body — Definition for basic labware

Returns: LabwareTypeResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	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.

post_v1_labware_types

sync(client: AuthenticatedClient | Client, body: LabwareTypeRequest | Unset = UNSET) -> LabwareTypeResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	LabwareTypeRequest \| Unset	UNSET

body — Definition for basic labware

Returns: LabwareTypeResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	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.