Lab Services — Models
AgentConfigurationResponse
Field | Type |
|---|---|
automation_cell_id | UUID |
sequence | int |
encrypted_reporting_api_key | None | str | Unset |
encrypted_tunnel_key | None | str | Unset |
tunnel_fingerprint | None | str | Unset |
AgentExpectationsResponse
Field | Type |
|---|---|
agent_version | None | str | Unset |
tunnel_host | None | str | Unset |
tunnel_finger_print | None | str | Unset |
AgentHeartbeatRequest
Field | Type |
|---|---|
automation_cell_id | UUID |
sent_date_time_offset | datetime.datetime |
system_name | None | str | Unset |
agent_version | None | str | Unset |
status_message | None | str | Unset |
log_messages | list[LogMessage] | None | Unset |
AutomationCell
Field | Type |
|---|---|
id | UUID |
is_gateway_connection | bool |
sql_db_key | UUID |
sequence | int |
agent_heartbeat_received | datetime.datetime |
system_name | None | str | Unset |
api_url | None | str | Unset |
api_key | None | str | Unset |
agent_secret | None | str | Unset |
agent_version | None | str | Unset |
last_agent_status_message | None | str | Unset |
CellarioEdgeActionResponse
Field | Type |
|---|---|
correlation_id | UUID |
operation_name | None | str | Unset |
parameters | CellarioEdgeActionResponseParametersType0 | None | Unset |
status | None | str | Unset |
resource_version_id | None | Unset | UUID |
metadata | Any | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
CellarioEdgeActionResponseParametersType0
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
CellarioEdgeFileResponse
Field | Type |
|---|---|
id | UUID |
blob_storage_file_id | UUID |
status | |
blob_storage_download_uri | None | str | Unset |
correlation_id | None | Unset | UUID |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
file_name | None | str | Unset |
blob_storage_file_name | None | str | Unset |
CellarioEdgeFileUploadStatus
Values
- ACTIVE — Active
- COMPLETED — Completed
- FAILED — Failed
- PENDING — Pending
CellarioEdgeOperationParameterResponse
Cellario Edge operation parameter response model
Field | Type |
|---|---|
name | None | str | Unset |
default_value | None | str | Unset |
CellarioEdgeOperationResponse
Field | Type |
|---|---|
correlation_id | UUID |
CellarioEdgeRequest
Cellario Edge request model
Field | Type |
|---|---|
reference_id | UUID |
name | str |
description | None | str | Unset |
CellarioEdgeResourceHealthResponse
Field | Type |
|---|---|
micro_host_status | None | str | Unset |
device_state | None | str | Unset |
current_operation | CellarioEdgeResourceOperationHealthResponse | None | Unset |
resource_name | None | str | Unset |
CellarioEdgeResourceOperationHealthResponse
Field | Type |
|---|---|
operation_name | None | str | Unset |
parameters | CellarioEdgeResourceOperationHealthResponseParametersType0 | None | Unset |
CellarioEdgeResourceOperationHealthResponseParametersType0
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
CellarioEdgeResourceOperationResponse
Cellario Edge resource operation response model
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
parameters | list[CellarioEdgeOperationParameterResponse] | None | Unset |
CellarioEdgeResourceResponse
Cellario Edge resource response model
Field | Type |
|---|---|
id | UUID |
reference_id | UUID |
cellario_edge_id | UUID |
name | None | str | Unset |
cellario_edge_reference_id | None | Unset | UUID |
operations | list[CellarioEdgeResourceOperationResponse] | None | Unset |
current_version_id | None | Unset | UUID |
CellarioEdgeResourceVersionResponse
Cellario Edge resource version response model
Field | Type |
|---|---|
id | UUID |
resource_reference_id | UUID |
resource_id | UUID |
version | int |
version_snapshot | None | ResourceSnapshotResponse | Unset |
version_hash | None | str | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
created_by_user_id | None | Unset | UUID |
last_modified_by_user_id | None | Unset | UUID |
CellarioEdgeResponse
Cellario Edge request model
Field | Type |
|---|---|
id | UUID |
reference_id | UUID |
name | str |
description | None | str | Unset |
key_id | None | Unset | UUID |
host_url | None | str | Unset |
systems | list[CellarioEdgeSystemResponse] | None | Unset |
CellarioEdgeSystemResponse
Cellario Edge system response model
Field | Type |
|---|---|
id | UUID |
is_connected | bool |
cellario_edge_id | UUID |
name | None | str | Unset |
cellario_edge_reference_id | None | Unset | UUID |
ClientInfoResponse
Field | Type |
|---|---|
reference_id | UUID |
client_id | None | str | Unset |
host_name | None | str | Unset |
system_name | None | str | Unset |
version_info | ClientInfoResponseVersionInfoType0 | None | Unset |
id | None | Unset | UUID |
description | None | str | Unset |
key_id | None | Unset | UUID |
name | None | str | Unset |
host_url | None | str | Unset |
plugin_info | None | PluginInfoResponse | Unset |
ClientInfoResponseVersionInfoType0
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
ConnectCellarioEdgeOperationRequest
Represents a request to connect a Cellario Edge resource
Field | Type |
|---|---|
connection_parameters | ConnectCellarioEdgeOperationRequestConnectionParametersType0 | None | Unset |
ConnectCellarioEdgeOperationRequestConnectionParametersType0
Connection parameters for establishing resource connection.
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
CreateAutomationConnection
Field | Type |
|---|---|
system_name | None | str | Unset |
other_system_names | list[str] | None | Unset |
api_key | None | str | Unset |
sql_db_key | None | Unset | UUID |
CreateNetworkGatewayRequest
Request model for creating a new network gateway configuration.
Field | Type |
|---|---|
name | str |
public_url | str |
gateway_settings |
DeadLetterMessagesResponse
Field | Type |
|---|---|
total_count | int |
messages | list[DeadLetterMessageResponse] | None | Unset |
DeadLetterMessageResponse
Field | Type |
|---|---|
id | int |
failure_count | int |
first_failed_on | datetime.datetime |
last_failed_on | datetime.datetime |
event_id | None | str | Unset |
event_type | None | str | Unset |
payload | None | str | Unset |
failure_reason | None | str | Unset |
correlation_id | None | Unset | UUID |
DeviceState
Values
- CONNECTED — Connected
- CONNECTING — Connecting
- DOINGOP — DoingOp
- ERROR — Error
- IDLE — Idle
- INITIALIZING — Initializing
- READY — Ready
- UNAVAILABLE — Unavailable
DriverHostFilesBatchRequest
Field | Type |
|---|---|
correlation_ids | list[UUID] | None | Unset |
status | CellarioEdgeFileUploadStatus | None | Unset |
ErrorResponse
Field | Type |
|---|---|
message | str |
reasons | list[ErrorResponse] | None | Unset |
metadata | ErrorResponseMetadataType0 | None | Unset |
ErrorResponseMetadataType0
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
EventType
Values
- ALL — All
- AUDIT — Audit
- DATA — Data
- DEADLOCK — Deadlock
- DRIVER — Driver
- GENERIC — Generic
- INVENTORY — Inventory
- OPERATION — Operation
- ORDER — Order
- SYSTEM — System
FilterItem
Field | Type |
|---|---|
filter_type | |
state | None | str | Unset |
operation | None | str | Unset |
context | None | str | Unset |
GatewaySettingsRequest
Gateway configuration settings for network gateway requests.
Field | Type |
|---|---|
gateway_type | |
correlation_id_name | str |
tls_termination | None | TlsTerminationSettingsRequest | Unset |
rate_limiting | None | RateLimitingSettingsRequest | Unset |
request_size_limiting | None | RequestSizeLimitingSettingsRequest | Unset |
ip_whitelisting | IpWhitelistingSettingsRequest | None | Unset |
routes | GatewaySettingsRequestRoutesType0 | None | Unset |
GatewaySettingsRequestRoutesType0
Route-specific configurations indexed by automation connection ID.
Field | Type |
|---|---|
additional_properties | dict[str, RouteSettingsRequest] |
additional_keys | list[str] |
GatewaySettingsResponse
Gateway configuration settings for network gateway responses.
Field | Type |
|---|---|
gateway_type | |
correlation_id_name | None | str | Unset |
tls_termination | None | TlsTerminationSettingsResponse | Unset |
rate_limiting | None | RateLimitingSettingsResponse | Unset |
request_size_limiting | None | RequestSizeLimitingSettingsResponse | Unset |
ip_whitelisting | IpWhitelistingSettingsResponse | None | Unset |
routes | GatewaySettingsResponseRoutesType0 | None | Unset |
GatewaySettingsResponseRoutesType0
Route-specific configurations indexed by automation connection ID.
Field | Type |
|---|---|
additional_properties | dict[str, RouteSettingsResponse] |
additional_keys | list[str] |
GatewayType
Values
- KONG — Kong
- TRAEFIK — Traefik
HookVersionResult
Field | Type |
|---|---|
name | None | str | Unset |
version | None | str | Unset |
IpWhitelistingSettingsRequest
IP whitelisting settings for the gateway.
Field | Type |
|---|---|
mode | |
allowed_ips | list[str] | None | Unset |
IpWhitelistingSettingsResponse
IP whitelisting settings for the gateway.
Field | Type |
|---|---|
mode | |
allowed_ips | list[str] | None | Unset |
LabwareType
The definition of the labware type
Field | Type |
|---|---|
grip_height | float |
fill_volume | float |
max_volume | float |
block_height | float |
stack_height | float |
thickness | float |
robot_speed | float |
id | None | str | Unset |
name | None | str | Unset |
systems | list[str] | None | Unset |
description | None | str | Unset |
density | int | None | Unset |
LogLevel
Values
- CRITICAL — Critical
- DEBUG — Debug
- ERROR — Error
- INFORMATION — Information
- NONE — None
- TRACE — Trace
- WARNING — Warning
LogMessage
Field | Type |
|---|---|
level | |
message | None | str | Unset |
NetworkGatewayResponse
Response model for network gateway configuration.
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
public_url | None | str | Unset |
parent_id | None | Unset | UUID |
gateway_settings | GatewaySettingsResponse | None | Unset |
date_created | datetime.datetime | None | Unset |
created_by_user_id | None | Unset | UUID |
date_last_modified | datetime.datetime | None | Unset |
last_modified_by_user_id | None | Unset | UUID |
NetworkNodeResponse
DTO representing a network node in the topology
Field | Type |
|---|---|
id | UUID |
node_type | |
parent_id | None | Unset | UUID |
type_specific_data | Any | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
NetworkNodeType
Values
- AUTOMATIONCELL — AutomationCell
- DRIVERHOST — DriverHost
- NETWORKGATEWAY — NetworkGateway
OnOffState
Values
- OFF — Off
- ON — On
Order
An Order represents a unit of work to be executed by Cellario for a specific protocol.
Field | Type |
|---|---|
id | int |
state | |
protocol_id | int |
start_time | datetime.datetime |
end_time | datetime.datetime |
inventory_scan | bool |
clear_storage | bool |
protocol_name | None | str | Unset |
description | None | str | Unset |
created_by | None | str | Unset |
email_recipients | None | str | Unset |
schedule_detail | None | OrderSchedule | Unset |
system | None | str | Unset |
order_samples | list[OrderSample] | None | Unset |
thread_outputs | list[ThreadOutput] | None | Unset |
parameters | list[RunOrderParameter] | None | Unset |
OrderSample
Represents a single piece of labware (plate, tipbox, tube rack, etc..) in an order
Field | Type |
|---|---|
id | int |
order_id | int |
plate_protocol_id | int |
resource_position_id | int |
barcode | None | str | Unset |
labware_type | None | str | Unset |
thread_name | None | str | Unset |
starting_resource | None | str | Unset |
starting_column | int | None | Unset |
starting_row | int | None | Unset |
labware | LabwareType | None | Unset |
OrderSchedule
The schedule information pertaining to when and how Cellario should start an order
Field | Type |
|---|---|
schedule_at | datetime.datetime | None | Unset |
protocol_step_id | int | None | Unset |
scheduled_after | int | None | Unset |
plate_number | int | None | Unset |
OrderState
Values
- CANCELED — Canceled
- CREATED — Created
- FINISHED — Finished
- PAUSED — Paused
- PAUSING — Pausing
- REMOVED — Removed
- SCANNING — Scanning
- SCRIPTING — Scripting
- STARTED — Started
- STARTING — Starting
- SUBMITTED — Submitted
OrderTemplate
An order template pre-defines labware, starting positions across threads in order to allow users to quickly create similar style orders.
Attributes:
id (int):
protocol_id (int): The Id of the Cellario Protocol
is_default (bool): Whether the template is the default for a given protocol.
systems (list[str] | None | Unset): The name of the system this order templates belongs to.
protocol_name (None | str | Unset): The name of the Cellario Protocol
description (None | str | Unset): The name/description of the Order Template
threads (list[OrderTemplateThread] | None | Unset):Field | Type |
|---|---|
id | int |
protocol_id | int |
is_default | bool |
systems | list[str] | None | Unset |
protocol_name | None | str | Unset |
description | None | str | Unset |
threads | list[OrderTemplateThread] | None | Unset |
OrderTemplateStep
This represents either an input, output or incubate step and the possible starting (and optionally max ending location) for a Cellario 'OrderSample'.
Attributes:
id (int):
protocol_step_id (int): The Id of the protocol step (operation)
step_type (OrderTemplateStepType):
resource_name (None | str | Unset): The storage device that will be used
column (int | None | Unset): This represents the minimum column that a plate can be placed in.
row (int | None | Unset): This represent the minimum row that a place can be placed in
ending_column (int | None | Unset): This represent the maximum row that a place can be placed in
ending_row (int | None | Unset): This represent the maximum row that a place can be placed inField | Type |
|---|---|
id | int |
protocol_step_id | int |
step_type | |
resource_name | None | str | Unset |
column | int | None | Unset |
row | int | None | Unset |
ending_column | int | None | Unset |
ending_row | int | None | Unset |
OrderTemplateStepType
Values
- INCUBATE — Incubate
- INPUT — Input
- NONE — None
- OUTPUT — Output
OrderTemplateThread
Field | Type |
|---|---|
id | int |
plate_protocol_id | int |
plate_protocol_name | None | str | Unset |
labware_type | None | str | Unset |
max_batch_size | int | None | Unset |
step_segments | list[OrderTemplateStep] | None | Unset |
times_used | int | None | Unset |
Parameter
Represents a Parameter (Name/Value/Description)
Field | Type |
|---|---|
name | None | str | Unset |
value | None | str | Unset |
description | None | str | Unset |
PatchNetworkGatewayRequest
Request model for partially updating a network gateway configuration. Only properties that are specified will be updated.
Attributes:
name (None | str | Unset): The name of the network gateway.
public_url (None | str | Unset): The public URL endpoint for the network gateway.
gateway_settings (GatewaySettingsRequest | None | Unset): The gateway configuration settings.Field | Type |
|---|---|
name | None | str | Unset |
public_url | None | str | Unset |
gateway_settings | GatewaySettingsRequest | None | Unset |
PlateDelayOption
Values
- ALL — All
- ALLEXCEPTFIRST — AllExceptFirst
- BATCHDELAY — BatchDelay
- FIRSTONLY — FirstOnly
- PREVIOUSFINISHED — PreviousFinished
PlateProtocol
Cellario PlateProtocol (aka Thread)
Field | Type |
|---|---|
id | int |
protocol_id | int |
delay_option | |
name | None | str | Unset |
tag | None | str | Unset |
protocol_steps | list[ProtocolStep] | None | Unset |
input_resources | list[str] | None | Unset |
output_resources | list[str] | None | Unset |
PluginInfoResponse
Field | Type |
|---|---|
name | None | str | Unset |
file_name | None | str | Unset |
file_version | None | str | Unset |
status | None | str | Unset |
error_message | None | str | Unset |
PortForwardRequest
Port forward configuration for gateway routing requests. Defines how traffic is forwarded through gateway route paths with TLS and path handling options.
Attributes:
outbound_port (int): The port where traffic will be forwarded on the destination service.
path (str): The listen path for the gateway route.
strip_path (bool): Whether to strip the path when forwarding requests.
tls_enabled (bool): Whether HTTPS protocol is enabled.
Defaults to false.Field | Type |
|---|---|
outbound_port | int |
path | str |
strip_path | bool |
tls_enabled | bool |
PortForwardResponse
Port forward configuration for gateway routing responses.
Field | Type |
|---|---|
outbound_port | int |
strip_path | bool |
tls_enabled | bool |
path | None | str | Unset |
PortType
Values
- INPUT — Input
- NONE — None
- OUTPUT — Output
ProblemDetails
Field | Type |
|---|---|
type_ | None | str | Unset |
title | None | str | Unset |
status | int | None | Unset |
detail | None | str | Unset |
instance | None | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
Property
This represents a propery.
Field | Type |
|---|---|
name | None | str | Unset |
description | None | str | Unset |
value | None | str | Unset |
Protocol
Field | Type |
|---|---|
id | int |
is_hidden | bool |
validated | bool |
locked | bool |
version | int |
name | None | str | Unset |
asset_id | None | Unset | UUID |
group | None | str | Unset |
notes | None | str | Unset |
created_by | None | str | Unset |
modified_by | None | str | Unset |
created_date | datetime.datetime | None | Unset |
modified_date | datetime.datetime | None | Unset |
email_recipients | None | str | Unset |
parent_protocol_id | int | None | Unset |
plate_protocols | list[PlateProtocol] | None | Unset |
properties | list[ProtocolProperty] | None | Unset |
parameters | list[ProtocolParameter] | None | Unset |
ports | list[ProtocolPort] | None | Unset |
version_label | None | str | Unset |
configured_systems | list[str] | None | Unset |
ProtocolParameter
Field | Type |
|---|---|
id | int |
protocol_id | int |
required_for_request | bool |
parameter_level | |
parameter_type | |
name | None | str | Unset |
default_value | None | str | Unset |
description | None | str | Unset |
choices | list[str] | None | Unset |
ProtocolParameterLevel
Values
- ORDER — Order
- SAMPLE — Sample
ProtocolParameterType
Values
- BOOL — Bool
- DATETIME — DateTime
- FILE — File
- NUMBER — Number
- STRING — String
- TIMESPAN — TimeSpan
ProtocolPort
Field | Type |
|---|---|
protocol_id | int |
plate_protocol_id | int |
type_ | |
plate_protocol_name | None | str | Unset |
port_name | None | str | Unset |
port_tag | None | str | Unset |
ProtocolProperty
Field | Type |
|---|---|
id | int |
protocol_id | int |
name | None | str | Unset |
value | None | str | Unset |
description | None | str | Unset |
ProtocolStep
Represent an Operation in a Protocol.
Field | Type |
|---|---|
id | int |
operation_id | int |
time_out | int |
simulation_time | int |
priority | int |
is_primary_merge | bool |
plate_protocol_id | int | None | Unset |
name | None | str | Unset |
step_notes | None | str | Unset |
merges | list[StepMerge] | None | Unset |
resource_assignments | list[str] | None | Unset |
RateLimitingSettingsRequest
Rate limiting settings for the gateway.
Field | Type |
|---|---|
mode | |
requests_per_minute | int | None | Unset |
RateLimitingSettingsResponse
Rate limiting settings for the gateway.
Field | Type |
|---|---|
mode | |
requests_per_minute | int | None | Unset |
RequestSizeLimitingSettingsRequest
Request size limiting settings for the gateway.
Field | Type |
|---|---|
mode | |
max_payload_mb | int | None | Unset |
RequestSizeLimitingSettingsResponse
Request size limiting settings for the gateway.
Field | Type |
|---|---|
mode | |
max_payload_mb | int | None | Unset |
Resource
A Resource is an entity that can be used in automation run such as a storage device, liquid handler, etc.
Field | Type |
|---|---|
state | |
is_enabled | bool |
has_driver | bool |
is_simulated | bool |
instance | int |
location | int |
name | None | str | Unset |
resource_type | None | str | Unset |
associated_resource | None | str | Unset |
associated_cart | None | str | Unset |
system_name | None | str | Unset |
resource_positions | list[ResourcePosition] | None | Unset |
properties | list[Property] | None | Unset |
envelope | int | None | Unset |
weight | None | str | Unset |
ResourceOperationSnapshotResponse
Resource operation snapshot response model
Field | Type |
|---|---|
name | None | str | Unset |
parameters | None | ResourceOperationSnapshotResponseParametersType0 | Unset |
ResourceOperationSnapshotResponseParametersType0
Operation parameters
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
ResourcePosition
Represents an individual position in a stack
Field | Type |
|---|---|
id | int |
column | int |
row | int |
enabled | bool |
persistent | bool |
resource_name | None | str | Unset |
description | None | str | Unset |
order_sample_id | int | None | Unset |
pitch | float | None | Unset |
plate_barcode | None | str | Unset |
ResourceSnapshotResponse
Resource snapshot response model
Field | Type |
|---|---|
driver_host_reference_id | UUID |
name | None | str | Unset |
operations | list[ResourceOperationSnapshotResponse] | None | Unset |
RouteSettingsRequest
Route-specific settings for a single connection. Uses NetworkNode ID to replace legacy connection IDs for improved network topology management.
Attributes:
network_node_id (UUID): The Network Node ID that this route is being created for.
Replaces legacy connection IDs to provide better network topology management.
network_node_type (NetworkNodeType):
tls_upstream_verification (OnOffState): DTO enum representing on/off state for gateway settings
host_name (None | str | Unset): The hostname of the upstream service for this route (retrieved from
AutomationCell.ApiUrl).
timeouts (None | TimeoutSettingsRequest | Unset): Timeout configurations for this route.
port_forwards (list[PortForwardRequest] | None | Unset): Port forward configurations for this route.Field | Type |
|---|---|
network_node_id | UUID |
network_node_type | |
tls_upstream_verification | |
host_name | None | str | Unset |
timeouts | None | TimeoutSettingsRequest | Unset |
port_forwards | list[PortForwardRequest] | None | Unset |
RouteSettingsResponse
Route-specific settings for a single connection. Uses NetworkNode ID to replace legacy connection IDs for improved network topology management.
Attributes:
network_node_id (UUID): The Network Node ID that this route is being created for.
Replaces legacy connection IDs to provide better network topology management.
tls_upstream_verification (OnOffState): DTO enum representing on/off state for gateway settings
host_name (None | str | Unset): The hostname of the upstream service for this route (retrieved from
AutomationCell.ApiUrl).
timeouts (None | TimeoutSettingsResponse | Unset): Timeout configurations for this route.
port_forwards (list[PortForwardResponse] | None | Unset): Port forward configurations for this route.Field | Type |
|---|---|
network_node_id | UUID |
tls_upstream_verification | |
host_name | None | str | Unset |
timeouts | None | TimeoutSettingsResponse | Unset |
port_forwards | list[PortForwardResponse] | None | Unset |
RpcError
Field | Type |
|---|---|
code | int |
message | None | str | Unset |
data | Any | Unset |
RpcInvokeAcceptedResponse
HTTP 202 response body for fire-and-forget RPC enqueue.
Field | Type |
|---|---|
correlation_id | UUID |
RpcInvokeRequest
HTTP request body for invoking an RPC method on a Cellario Edge system.
Field | Type |
|---|---|
method | None | str | Unset |
params | Any | Unset |
id | None | Unset | UUID |
timeout | None | str | Unset |
RpcInvokeResponse
HTTP response body for a synchronous RPC invocation. Exactly one of Lab.Services.Core.Dto.DriverHost.RpcInvokeResponse.Result or Lab.Services.Core.Dto.DriverHost.RpcInvokeResponse.Error is set, mirroring JSON-RPC 2.0.
Attributes:
id (UUID): Echo of the request id.
result (Any | Unset): Result payload on success. Null when
Lab.Services.Core.Dto.DriverHost.RpcInvokeResponse.Error is set.
error (None | RpcError | Unset): Error details when the component returned a JSON-RPC error response.
Null on success.Field | Type |
|---|---|
id | UUID |
result | Any | Unset |
error | None | RpcError | Unset |
RunOrderParameter
Represents an overriden protocol parameter with a new value/
Field | Type |
|---|---|
id | int |
protocol_parameter_id | int |
run_order_id | int |
parameter_level | |
parameter_type | |
order_sample_id | int | None | Unset |
parameter_value | None | str | Unset |
parameter_name | None | str | Unset |
StartCellarioEdgeOperationRequest
Represents a request to start an operation
Field | Type |
|---|---|
parameters | None | StartCellarioEdgeOperationRequestParametersType0 | Unset |
metadata | Any | Unset |
StartCellarioEdgeOperationRequestParametersType0
Operation parameters
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
StepMerge
Field | Type |
|---|---|
plate_protocol_id | int |
protocol_step_id | int |
times_used | int |
is_source | bool |
Subscriber
A subscriber represents a user/party that is interested in receiving notifications of events.
Field | Type |
|---|---|
id | int |
invert_filter_behavior | bool |
user | None | str | Unset |
url | None | str | Unset |
filters | list[FilterItem] | None | Unset |
custom_headers | list[Parameter] | None | Unset |
systems | list[str] | None | Unset |
SystemAction
Values
- NONE — None
- PAUSE — Pause
- START — Start
- STOP — Stop
SystemActionRequest
Field | Type |
|---|---|
action |
SystemControlMode
Values
- AGENT — Agent
- EDGE — Edge
SystemResult
Field | Type |
|---|---|
id | UUID |
state | |
control_mode | |
is_available | bool |
name | None | str | Unset |
description | None | str | Unset |
location_id | int | None | Unset |
SystemState
Values
- INERROR — InError
- INITIALIZED — Initialized
- INITIALIZING — Initializing
- PAUSED — Paused
- PAUSING — Pausing
- RUNNING — Running
- UNINITIALIZED — UnInitialized
SystemVersionInfoResult
Field | Type |
|---|---|
is_available | bool |
name | None | str | Unset |
cellario_version | None | str | Unset |
api_version | None | str | Unset |
assembly_version | None | str | Unset |
hook_versions | list[HookVersionResult] | None | Unset |
ThreadOutput
Field | Type |
|---|---|
order_id | int |
resource_position_id | int |
plate_protocol_id | int |
id | int | None | Unset |
resource_name | None | str | Unset |
starting_column | int | None | Unset |
starting_row | int | None | Unset |
ending_position_id | int | None | Unset |
ending_column | int | None | Unset |
ending_row | int | None | Unset |
TimeoutSettingsRequest
Timeout settings for network operations.
Field | Type |
|---|---|
connect | None | str | Unset |
read | None | str | Unset |
write | None | str | Unset |
TimeoutSettingsResponse
Timeout settings for network operations.
Field | Type |
|---|---|
connect | None | str | Unset |
read | None | str | Unset |
write | None | str | Unset |
TlsTerminationSettingsRequest
TLS termination settings for the gateway.
Field | Type |
|---|---|
mode |
TlsTerminationSettingsResponse
TLS termination settings for the gateway.
Field | Type |
|---|---|
mode |
UpdateAutomationConnection
Field | Type |
|---|---|
system_name | None | str | Unset |
api_url | None | str | Unset |
is_gateway_connection | bool | None | Unset |
other_system_names | list[str] | None | Unset |
api_key | None | str | Unset |
sql_db_key | None | Unset | UUID |
UpdateParentRequest
DTO for updating parent relationships in network topology
Field | Type |
|---|---|
id | UUID |
parent_id | None | Unset | UUID |
VersionInfo
Field | Type |
|---|---|
version | None | str | Unset |