Data API — Labware Mappings Collections

10 min

labware_mapping_collection_create

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

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

body — Request to create a labware mapping collection

Returns: LabwareMappingCollectionResponse | 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_mapping_collection_delete

sync(labware_mapping_collection_id: UUID, client: AuthenticatedClient | Client, include_mappings: bool | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
labware_mapping_collection_id	UUID	required
client	AuthenticatedClient \| Client	required
include_mappings	bool \| Unset	UNSET

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_mapping_collection_describe

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

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

Returns: LabwareMappingCollectionResponse | 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_mapping_collection_list

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, last_modified_by_user_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[LabwareMappingCollectionResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
last_modified_by_user_id	UUID \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[LabwareMappingCollectionResponse] | 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_mapping_collection_update

sync(labware_mapping_collection_id: UUID, client: AuthenticatedClient | Client, body: UpdateLabwareMappingCollectionRequest | Unset = UNSET) -> LabwareMappingCollectionResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
labware_mapping_collection_id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateLabwareMappingCollectionRequest \| Unset	UNSET

body — Request to update a labware mapping collection

Returns: LabwareMappingCollectionResponse | 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.