Data API — Plates
plate_by_id
sync(id: UUID, client: AuthenticatedClient | Client) -> PlateResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: PlateResponse | 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. |
plate_delete
sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
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. |
plate_list
sync(client: AuthenticatedClient | Client, barcode: str | Unset = UNSET, labware_type_name: str | Unset = UNSET, labware_type_id: UUID | Unset = UNSET, location_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[PlateResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
barcode | str | Unset | UNSET |
labware_type_name | str | Unset | UNSET |
labware_type_id | UUID | Unset | UNSET |
location_id | UUID | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[PlateResponse] | 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. |
plate_update
sync(id: UUID, client: AuthenticatedClient | Client, body: UpdatePlateRequest | Unset = UNSET) -> PlateResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
body | UpdatePlateRequest | Unset | UNSET |
- body — Information used to create a plate
Returns: PlateResponse | 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. |
post_v1_plates
sync(client: AuthenticatedClient | Client, body: CreatePlateRequest | Unset = UNSET) -> PlateResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | CreatePlateRequest | Unset | UNSET |
- body — Information used to create a plate
Returns: PlateResponse | 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. |