Data API — Systems

30 min

cellario_system_add_resource

sync(cellario_system_id: UUID, resource_id: UUID, client: AuthenticatedClient | Client) -> CellarioSystemResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
cellario_system_id	UUID	required
resource_id	UUID	required
client	AuthenticatedClient \| Client	required

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

cellario_system_create

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

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

body — Information used to create a new cellario_system

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

cellario_system_delete

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

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
delete_all_associated_data	bool \| Unset	False

delete_all_associated_data — Default: False.

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.

cellario_system_delete_labware

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

Parameter	Type	Default
cellario_system_id	UUID	required
labware_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.

cellario_system_describe

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

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

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

cellario_system_get_installer

sync(client: AuthenticatedClient | Client) -> File | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required

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

cellario_system_get_labware

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

Parameter	Type	Default
cellario_system_id	UUID	required
labware_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | LabwareTypeListResponse | 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.

cellario_system_list

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, description: str | Unset = UNSET, thumbnail_ref: str | Unset = UNSET, image_ref: str | Unset = UNSET, state: SystemState | Unset = UNSET, alert_state: SystemAlertState | Unset = UNSET, cloud_connectivity: CloudConnectivityState | Unset = UNSET, location_id: UUID | Unset = UNSET, cellario_version: str | Unset = UNSET, sort: list[CellarioSystemSort] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[CellarioSystemListItemResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
description	str \| Unset	UNSET
thumbnail_ref	str \| Unset	UNSET
image_ref	str \| Unset	UNSET
state	SystemState \| Unset	UNSET
alert_state	SystemAlertState \| Unset	UNSET
cloud_connectivity	CloudConnectivityState \| Unset	UNSET
location_id	UUID \| Unset	UNSET
cellario_version	str \| Unset	UNSET
sort	list[CellarioSystemSort] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[CellarioSystemListItemResponse] | 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.

cellario_system_push_labware

sync(cellario_system_id: UUID, labware_id: UUID, client: AuthenticatedClient | Client, body: LabwareTypeSystemRequest | Unset = UNSET) -> Any | LabwareTypeListResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
cellario_system_id	UUID	required
labware_id	UUID	required
client	AuthenticatedClient \| Client	required
body	LabwareTypeSystemRequest \| Unset	UNSET

body — Definition for basic labware

Returns: Any | LabwareTypeListResponse | 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.

cellario_system_remove_resource

sync(cellario_system_id: UUID, resource_id: UUID, client: AuthenticatedClient | Client) -> CellarioSystemResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
cellario_system_id	UUID	required
resource_id	UUID	required
client	AuthenticatedClient \| Client	required

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

cellario_system_update

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

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

body — Information used to create a new cellario_system

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

status_report

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ConfigurationStatusResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ConfigurationStatusResponse] | 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.

system_run_order_control

sync(cellario_system_id: UUID, client: AuthenticatedClient | Client, body: RunOrderControlRequest | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
cellario_system_id	UUID	required
client	AuthenticatedClient \| Client	required
body	RunOrderControlRequest \| Unset	UNSET

body — Represents a request to control a run order.

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.

system_scheduler_control

sync(cellario_system_id: UUID, client: AuthenticatedClient | Client, body: SchedulerControlRequest | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
cellario_system_id	UUID	required
client	AuthenticatedClient \| Client	required
body	SchedulerControlRequest \| Unset	UNSET

body — Represents a request to control the Cellario scheduler.

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.

unmapped_system_list

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

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[str] | 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.