Data API — Models
ActiveOperationResponse
Information about a operation that is currently active
Field | Type |
|---|---|
run_id | int |
sample_name | str |
operation | str |
current_resource_name | str |
status | |
valid_actions | list[OperationAction] |
destination_resource_name | None | str | Unset |
started_date_time | datetime.datetime | None | Unset |
finished_date_time | datetime.datetime | None | Unset |
notes | None | str | Unset |
sample_operation_id | int | None | Unset |
sample_id | int | None | Unset |
ActivityListItemResponse
Basic information about an activity
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
is_published | bool |
version | int |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | 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 |
parameter_schema | CustomSchemaResponse | None | Unset |
ActivityParameterSchemaResponse
Protocol parameters
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyResponse] | None | Unset |
ActivityResponse
Basic information about an activity
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
version | int |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
is_published | bool | None | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
files | list[FileReferenceResponse] | None | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | 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 |
properties | list[ResourcePropertyResponse] | None | Unset |
ActivitySort
Values
- ACTIVITY_TYPE
- ACTIVITY_TYPE_DESC
- DESCRIPTION
- DESCRIPTION_DESC
- NAME
- NAME_DESC
- VERSION
- VERSION_DESC
ActivityTypeEnum
Values
- PROCEDURE
- PROTOCOL
- SCIENTIFIC_PROTOCOL
- TIME_RESERVATION
- WORKFLOW
ActivityUploadFileFilesBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
ActivityUploadFileJsonBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
AddUserGroupMembersRequest
Request to add members to a user group
Field | Type |
|---|---|
user_ids | list[UUID] |
ApiKeyCreatedResponse
Response model returned when creating a new API key. Contains the full key value (only shown once at creation).
Attributes:
id (UUID): Unique identifier for this API key.
description (None | str): Description to help identify the key's purpose.
hint (None | str): Short random prefix of the key for identification.
key (None | str): The full API key value. Only returned at creation time.
expires_at (datetime.datetime | None | Unset): When the key expires. Null if no expiration.
date_created (datetime.datetime | None | Unset): When this API key was created.Field | Type |
|---|---|
id | UUID |
description | None | str |
hint | None | str |
key | None | str |
expires_at | datetime.datetime | None | Unset |
date_created | datetime.datetime | None | Unset |
ApiKeyCreateRequest
Request model for creating a new API key.
Field | Type |
|---|---|
description | str |
roles | list[AuthenticatedServices] |
expires_at | datetime.datetime | None | Unset |
ApiKeyListItemResponse
Simplified response model for listing API keys.
Field | Type |
|---|---|
id | UUID |
description | None | str |
hint | None | str |
is_expired | bool |
expires_at | datetime.datetime | None | Unset |
date_created | datetime.datetime | None | Unset |
ApiKeyResponse
Response model for API key details (without the actual key value).
Field | Type |
|---|---|
id | UUID |
description | None | str |
hint | None | str |
owned_by_user_id | UUID |
owned_by_profile_id | UUID |
is_expired | bool |
expires_at | datetime.datetime | None | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
AppInfo
Field | Type |
|---|---|
name | None | str | Unset |
version | None | str | Unset |
sha | None | str | Unset |
description | None | str | Unset |
AssociateScientificProtocolProtocolRequest
Associate a protocol to a scientific protocol
Field | Type |
|---|---|
protocol_id | UUID |
is_default | bool |
AuditActionResponse
Historical tracking of an action performed by a user
Field | Type |
|---|---|
type_ | |
date | datetime.datetime |
user_id | UUID |
description | None | str | Unset |
AuditActionType
Values
- MANUAL_TASK_FAILED
- MANUAL_TASK_FINISHED
- MANUAL_TASK_STARTED
AuthenticatedServices
Values
- BASIC
- EXTENSIONS
- LABSERVICES
AvailabilityResponse
Represents calendar availability data including participants, commitments, and lab configurations
Field | Type |
|---|---|
participants | list[ParticipantResponse] |
commitments | list[CommitmentResponse] |
start | datetime.datetime |
end | datetime.datetime |
possible_lab_configurations | list[LabConfigurationResponse] | None | Unset |
AvailableResourceResponse
Response model for an available resource that can be configured for a protocol
Field | Type |
|---|---|
resource_id | UUID |
scheduling_constraint | |
resource_name | None | str | Unset |
parent_id | None | Unset | UUID |
parent_type | None | ParticipantType | Unset |
BulkCreateUserResultsResponse
Response for a single user when adding users in bulk
Field | Type |
|---|---|
user | None | Unset | UserResponse |
state | None | str | Unset |
error | None | str | Unset |
BulkPlateTransfersStateUpdateRequest
Bulk state update of plate transfers request
Field | Type |
|---|---|
state | |
plate_transfer_ids | list[UUID] | None | Unset |
BulkReplaceReservationsResponse
Response model for bulk replace operation on protocol resource reservations
Field | Type |
|---|---|
reservations | list[ProtocolResourceReservationResponse] | None | Unset |
BulkUsersCreateListFilesBody
Field | Type |
|---|---|
file | File |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
BulkUsersCreateListJsonBody
Field | Type |
|---|---|
file | File |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
CalendarAvailabilityOrderFilterApiModel
A set of reductive refinements that can be applied when searching for a time slot that is available for the work order
Attributes:
conditions (list[ConfigurationCondition]): The conditions that are selected that reduce refine the way the order
is executed and therefore the number of participants required.
start (datetime.datetime | None | Unset): The start of the time period that is being searched for available time
slots. If not provided, defaults to now.
end (datetime.datetime | None | Unset): The end of the time period that is being searched for available time
slots. If not provided, defaults to 7 days from now.
user_id_filter (None | Unset | UUID): Optional filter to only return commitments for orders created by or
requested for this user.
When provided, only commitments where Order.CreatedByUserId or WorkOrder.RequestedByUserId matches this value
are returned.
When not provided, all commitments are returned.Field | Type |
|---|---|
conditions | list[ConfigurationCondition] |
start | datetime.datetime | None | Unset |
end | datetime.datetime | None | Unset |
user_id_filter | None | Unset | UUID |
CalendarAvailabilityParticipantsFilterApiModel
Filter model for querying calendar availability for specific participants
Field | Type |
|---|---|
participant_ids | list[UUID] |
start | datetime.datetime | None | Unset |
end | datetime.datetime | None | Unset |
user_id_filter | None | Unset | UUID |
CalendarAvailabilitySnapshot
Field | Type |
|---|---|
commitments | |
pool_claims | list[PoolClaimSnapshot] |
start | datetime.datetime |
end | datetime.datetime |
CalendarAvailabilityWindowRequest
Request for a point-in-time availability snapshot for a set of participants across a time window. Feeds the Schedule Order drawer's valid-start-times precomputation (client-side) and the Schedule Anyway conflict disclosure.
Distinct from Cellario.Cloud.Data.Api.Models.Calendar.CalendarAvailabilityParticipantsFilterApiModel, which targets the pre-calendaring availability surface (systems, flex-carts, work orders). This shape is purpose-built for the workflow-calendaring placement service: it returns a CalendarAvailabilitySnapshot with both hard commitments and pool claims intersecting the window.
Attributes:
participants (list[ParticipantIdentifier]): Participants to query. Empty is allowed and returns an empty
snapshot.
start (datetime.datetime): Window start (inclusive).
end (datetime.datetime): Window end (exclusive).Field | Type |
|---|---|
participants | list[ParticipantIdentifier] |
start | datetime.datetime |
end | datetime.datetime |
CalendarConditionKeys
Values
- CART_ID
- PROTOCOL_ID
- RESOURCE_ID
- SYSTEM_ID
- TEMPLATE_ID
CalendarEntryResponse
API projection of a CalendarEntry aggregate for read endpoints. Mirrors the entity but drops EF navigation noise and audit-user nav properties. The JSONB shapes (Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.ParticipantPool, Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.Release) are returned as-is from the domain record types -- they are already plain, serializable records.
A handful of fields are populated only on parents or only on children. They are nullable here on the shared shape so the recursive Children tree can use one type; consumers should treat the parent-only set as null on child entries and vice versa.
Attributes:
id (UUID): Entry id.
name (str): Display label shown on the calendar.
children (list[CalendarEntryResponse]): Child entries (per-task rows under a workflow-order parent). Empty for
leaf entries and for work-order-sourced entries.
parent_calendar_entry_id (None | Unset | UUID): Parent entry id; null for top-level entries.
source_workflow_order_id (None | Unset | UUID): Originating workflow order id on top-level workflow entries;
null for
child entries and for work-order-sourced entries.
estimated_duration (None | str | Unset): Planner-provided duration estimate; null for unplaced templates.
planned_start (datetime.datetime | None | Unset): Absolute start time once placed; null for unplaced templates.
planned_end (datetime.datetime | None | Unset): Absolute end time once placed; null for unplaced templates.
due_date (datetime.datetime | None | Unset): Optional soft target by which the entry should be completed.
Set on top-level (parent) entries only in 1.17 -- per-task due dates may
be added later. Distinct from Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.PlannedEnd: due date
is the
customer-/operator-stated commitment, while
Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.PlannedEnd is
the scheduler's actual placement. Null when no due date is specified.
participant_pool (None | ParticipantPoolRecord | Unset): X-of-N pool claim (JSONB). Null for entries with no
pool -- guided
tasks, parent entries, and all 1.17 entries until pool authoring ships.
release (None | ReleaseRecord | Unset): Release metadata (JSONB). Null while active; populated on cancel or
reschedule with who released it, when, and why.
created_by_user_id (None | Unset | UUID): User id of the operator who created the originating workflow order.
Populated on top-level workflow entries only; null on child entries and
on work-order-sourced entries. Returned as a raw id -- the UI resolves
the user name on demand (e.g. tooltip hover).
workflow_order_user_facing_id_prefix (None | str | Unset): User-facing id prefix captured at placement (e.g.
`"SCI"`).
Parent entries only; null on children. The UI assembles the display id
as `{prefix}-{number}`.
workflow_order_user_facing_id_number (int | None | Unset): User-facing id number captured at placement. Parent
entries only;
null on children.
workflow_order_state (None | Unset | WorkflowOrderState): Live workflow-order state read fresh on every list
call. Parent
entries only; null on children. Null when the source workflow order
could not be resolved (data drift -- the FK is RESTRICT but the
response prefers explicit absence to falsifying state).
workflow_order_step_id (None | Unset | UUID): FK back to the originating `WorkflowOrderStep`. Populated on child
entries that map 1:1 to a workflow step; null on parents and on
work-order-sourced entries. Lets the UI fetch the step's runtime state
(in-progress, failed, etc.) when it needs to color-code the row beyond
the static Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.StepType classification.
parent_workflow_order_step_id (None | Unset | UUID): Immediate parent of
Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.WorkflowOrderStepId in the workflow-order
step tree -- the enclosing branch arm, parallel-split arm, loop body, etc.
Lets the calendar UI assign per-branch lanes to overlapping children
without re-fetching the step tree for each order. Null on parent entries,
on work-order-sourced entries, on top-level workflow steps that have no
container, and when the source step's parent could not be resolved
(consistent with Cellario.Cloud.Data.Api.Models.Calendar.CalendarEntryResponse.WorkflowOrderStepId's
nullability).
step_type (CalendarEntryStepType | None | Unset): Coarse step classifier derived from the originating step's
`HintsJson["elementType"]`. Drives the default child-row dot color
and type label in the calendar UI. `Unknown` when the source step
has no recognizable element type or could not be located.
step_state (None | Unset | WorkflowStepState): Live workflow-step state read fresh on every list call. Child
entries
only; null on parents. Null when the source step could not be
resolved.
committed_worker (CommittedWorkerRecord | None | Unset): Participant committed to this child entry (the "worker"
rendered inline
on the calendar row). Null on guided steps (no commitment) and when the
commitment's participant could not be resolved.Field | Type |
|---|---|
id | UUID |
name | str |
children | list[CalendarEntryResponse] |
parent_calendar_entry_id | None | Unset | UUID |
source_workflow_order_id | None | Unset | UUID |
estimated_duration | None | str | Unset |
planned_start | datetime.datetime | None | Unset |
planned_end | datetime.datetime | None | Unset |
due_date | datetime.datetime | None | Unset |
participant_pool | None | ParticipantPoolRecord | Unset |
release | None | ReleaseRecord | Unset |
created_by_user_id | None | Unset | UUID |
workflow_order_user_facing_id_prefix | None | str | Unset |
workflow_order_user_facing_id_number | int | None | Unset |
workflow_order_state | None | Unset | WorkflowOrderState |
workflow_order_step_id | None | Unset | UUID |
parent_workflow_order_step_id | None | Unset | UUID |
step_type | CalendarEntryStepType | None | Unset |
step_state | None | Unset | WorkflowStepState |
committed_worker | CommittedWorkerRecord | None | Unset |
CalendarEntryStepType
Values
- BRANCH
- DEVICE_OPERATION
- GUIDED
- LOOP
- SCRIPT
- UNKNOWN
CancelManualTaskRequest
Request model for canceling a manual task instance.
Field | Type |
|---|---|
skip | bool |
reason | None | str | Unset |
CancelWorkflowOrderRequest
Request DTO for cancelling a workflow order.
Field | Type |
|---|---|
cancellation_reason | None | str | Unset |
CartConnectionState
Values
- CONNECTED_TO_SYSTEM
- DISCONNECTED
- DOCKED
CartMinimalResponse
Minimal information about a Cart
Field | Type |
|---|---|
id | UUID |
is_flex_cart | bool |
name | None | str | Unset |
CartResponse
Model to describe a cart which represents the physical objects that are used in a laboratory
Field | Type |
|---|---|
id | UUID |
is_flex_cart | bool |
name | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
location | LocationMinimalResponse | None | Unset |
resources | list[ResourceMinimalResponse] | 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 |
CellarioHookMinimalResponse
Information about a hook in CellarioScheduler
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
version | None | str | Unset |
CellarioLabwareType
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 |
description | None | str | Unset |
density | int | None | Unset |
CellarioOrder
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 | CellarioOrderSchedule | None | Unset |
cellario_system | None | str | Unset |
order_samples | list[CellarioOrderSample] | None | Unset |
thread_outputs | list[CellarioThreadOutput] | None | Unset |
parameters | list[CellarioRunOrderParameter] | None | Unset |
CellarioOrderSample
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 | CellarioLabwareType | None | Unset |
CellarioOrderSchedule
Field | Type |
|---|---|
schedule_at | datetime.datetime | None | Unset |
protocol_step_id | int | None | Unset |
scheduled_after | int | None | Unset |
plate_number | int | None | Unset |
CellarioOrderState
Values
- CANCELED
- CREATED
- FINISHED
- PAUSED
- PAUSING
- REMOVED
- SCRIPTING
- STARTED
- STARTING
- SUBMITTED
CellarioOrderTemplate
Field | Type |
|---|---|
id | int |
protocol_id | int |
is_default | bool |
protocol_name | None | str | Unset |
description | None | str | Unset |
threads | list[CellarioOrderTemplateThread] | None | Unset |
CellarioOrderTemplateStep
Field | 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 |
CellarioOrderTemplateThread
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[CellarioOrderTemplateStep] | None | Unset |
times_used | int | None | Unset |
CellarioPlateProtocol
Field | Type |
|---|---|
id | int |
protocol_id | int |
delay_option | |
name | None | str | Unset |
tag | None | str | Unset |
protocol_steps | list[CellarioProtocolStep] | None | Unset |
input_resources | list[str] | None | Unset |
output_resources | list[str] | None | Unset |
CellarioProtocol
Field | Type |
|---|---|
id | int |
is_hidden | bool |
validated | bool |
locked | bool |
version | int |
name | None | str | Unset |
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[CellarioPlateProtocol] | None | Unset |
properties | list[CellarioProtocolProperty] | None | Unset |
parameters | list[CellarioProtocolParameter] | None | Unset |
ports | list[CellarioProtocolPort] | None | Unset |
thread_ratios | list[CellarioThreadRatio] | None | Unset |
version_label | None | str | Unset |
configured_systems | list[str] | None | Unset |
events | list[CellarioProtocolEvent] | None | Unset |
CellarioProtocolEvent
Field | Type |
|---|---|
id | int |
protocol_id | int |
sequence | int |
script_id | int | None | Unset |
event_name | None | str | Unset |
description | None | str | Unset |
CellarioProtocolParameter
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 |
CellarioProtocolPort
Field | Type |
|---|---|
protocol_id | int |
plate_protocol_id | int |
type_ | |
protocol_step_id | int |
plate_protocol_name | None | str | Unset |
port_name | None | str | Unset |
port_tag | None | str | Unset |
CellarioProtocolProperty
Field | Type |
|---|---|
id | int |
protocol_id | int |
name | None | str | Unset |
value | None | str | Unset |
description | None | str | Unset |
CellarioProtocolStep
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[CellarioStepMerge] | None | Unset |
resource_assignments | list[str] | None | Unset |
CellarioResourceProperty
Field | Type |
|---|---|
name | None | str | Unset |
value | None | str | Unset |
description | None | str | Unset |
CellarioRunOrderParameter
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 |
CellarioStepMerge
Field | Type |
|---|---|
plate_protocol_id | int |
protocol_step_id | int |
times_used | int |
is_source | bool |
CellarioSystemListItemResponse
Detailed information about a cellario_system
Field | Type |
|---|---|
id | UUID |
state | |
alert_state | |
data_collection_default | |
cloud_connectivity | |
control_mode | |
resource_count | int |
db_key | None | Unset | UUID |
name | None | str | Unset |
nickname | None | str | Unset |
description | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
location | LocationMinimalResponse | None | Unset |
resources | list[ResourceMinimalResponse] | None | Unset |
cellario_version | None | str | Unset |
display_hex_color | None | str | Unset |
CellarioSystemMinimalResponse
Minimal information about a cellario_system
Field | Type |
|---|---|
id | UUID |
location_id | UUID |
cloud_connectivity | |
alert_state | |
name | None | str | Unset |
nickname | None | str | Unset |
display_hex_color | None | str | Unset |
CellarioSystemResponse
Detailed information about a cellario_system
Field | Type |
|---|---|
id | UUID |
state | |
alert_state | |
is_flex_cart | bool |
data_collection_default | |
data_capture_model | |
cloud_connectivity | |
control_mode | |
db_key | None | Unset | UUID |
name | None | str | Unset |
nickname | None | str | Unset |
description | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
location | LocationMinimalResponse | None | Unset |
resources | list[ResourceMinimalResponse] | None | Unset |
carts | list[CartMinimalResponse] | None | Unset |
hooks | list[CellarioHookMinimalResponse] | None | Unset |
labware | list[LabwareTypeMinimalResponse] | None | Unset |
api_version | None | str | Unset |
assembly_version | None | str | Unset |
cellario_version | None | str | Unset |
display_hex_color | None | str | Unset |
CellarioSystemSort
Values
- CELLARIO_VERSION
- CELLARIO_VERSION_DESC
- DESCRIPTION
- DESCRIPTION_DESC
- LOCATION_NAME
- LOCATION_NAME_DESC
- NAME
- NAME_DESC
- STATE
- STATE_DESC
CellarioThreadOutput
Field | Type |
|---|---|
order_id | int |
plate_protocol_id | int |
resource_position_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 |
CellarioThreadRatio
Field | Type |
|---|---|
plate_protocol_id | int |
ratio | float |
plate_protocol_name | None | str | Unset |
CellarioWellTransfer
Field | Type |
|---|---|
id | int |
source_id | int |
source_column | int |
source_row | int |
dest_id | int |
destination_column | int |
destination_row | int |
tip_id | int |
tip_column | int |
tip_row | int |
volume | float |
order_id | int |
notes | None | str | Unset |
source_plate_type | None | str | Unset |
additional_properties | list[CellarioResourceProperty] | None | Unset |
ChoicesRequest
Set of information to create or update a set of choices
Field | Type |
|---|---|
type_ | |
name | None | str | Unset |
description | None | str | Unset |
choices | list[str] | None | Unset |
ChoicesResponse
Data returned that represents a set of choices
Field | Type |
|---|---|
id | UUID |
type_ | |
name | None | str | Unset |
description | None | str | Unset |
choices | list[str] | None | Unset |
ChoicesUpdateRequest
Set of information to create or update a set of choices
Field | Type |
|---|---|
name | None | str | Unset |
description | None | str | Unset |
choices | list[str] | None | Unset |
CloneFromLibraryTypeRequest
Request body for POST /parameters//clone-from-library-type. Carries the per-task overrides applied to the top-level clone of a library-type descriptor. Type and Widget are inherited from the source library type and cannot be overridden here.
Attributes:
name (str): The name to set on the cloned top-level descriptor. Required.
required (bool): Required flag for the cloned top-level descriptor.
read_only (bool): Read-only flag for the cloned top-level descriptor.
display_hints (None | ParameterDisplayHintsRequest | Unset): Display hints applied to the top-level clone. The
Widget field on this request is
ignored — the clone preserves the source library type's widget. Label and Description
override the source values.
validation (None | ParameterValidationRequest | Unset): Validation rules for the cloned top-level descriptor.
When null, the source's
validation is copied verbatim.
default_value (None | str | Unset): Default value for the cloned top-level descriptor. JSON-encoded. When null,
the
source's default value is copied verbatim.Field | Type |
|---|---|
name | str |
required | bool |
read_only | bool |
display_hints | None | ParameterDisplayHintsRequest | Unset |
validation | None | ParameterValidationRequest | Unset |
default_value | None | str | Unset |
CloudConnectivityState
Values
- OFFLINE
- ONLINE
CommentResponse
Represents a comment
Field | Type |
|---|---|
id | UUID |
date_created | datetime.datetime |
text | None | str | Unset |
created_by_user | None | Unset | UserMinimalResponse |
CommitmentResponse
Represents a calendar commitment (scheduled work) for a participant
Field | Type |
|---|---|
id | UUID |
participant_id | UUID |
start | datetime.datetime |
end | datetime.datetime |
order_name | str |
order_user_facing_id | str |
order_state | |
order_id | None | Unset | UUID |
CommittedWorkerRecord
Lightweight projection of the participant committed to a child CalendarEntry. Surfaced on the calendar response so the UI can render the worker label inline on a child row without an extra round trip.
Populated by resolving the single Commitment attached to the child entry through !:Cellario.Cloud.Data.Services.Common.IParticipantResolver. Null on guided tasks (no commitment) and on entries whose participant could not be resolved (e.g. the underlying participant has been deleted). Intentionally kept to id + name -- richer participant detail is available via the /v1/calendar/participants endpoint when the UI needs it (e.g. tooltip hover).
Attributes:
id (UUID): Participant id (system, cart, flex-cart, or resource).
name (str): Display name as provided by `IParticipantResolver`.Field | Type |
|---|---|
id | UUID |
name | str |
ConcentrationUnit
Values
- MICROMOLAR
- MILLIMOLAR
- MOLAR
- NANOMOLAR
- PICOMOLAR
- UNSPECIFIED
ConfigurationCondition
Represents a condition that must be met for a laboratory configuration to be valid This is used to specify requirements such as equipment, environment, or other criteria needed for the work order to be executed.
Attributes:
key (CalendarConditionKeys):
value (str): The required value for this conditionField | Type |
|---|---|
key | |
value | str |
ConfigurationStatus
Values
- ERROR
- OK
- WARNING
ConfigurationStatusResponse
What is going wrong
Field | Type |
|---|---|
name | str |
configuration_status | |
sub_items | list[ConfigurationStatusResponse] |
effect | None | str | Unset |
action_item | None | str | Unset |
ConflictDetail
Field | Type |
|---|---|
participant_id | UUID |
overlap_start | datetime.datetime |
overlap_end | datetime.datetime |
kind | |
conflicting_calendar_entry_id | None | Unset | UUID |
conflicting_workflow_order_id | None | Unset | UUID |
ConflictKind
Values
- HARD_COMMITMENT
- POOL_CLAIM
Connection
Field | Type |
|---|---|
id | UUID |
source_step_id | UUID |
target_step_id | UUID |
source_handle | None | str | Unset |
target_handle | None | str | Unset |
Coordinate
UI coordinates
Field | Type |
|---|---|
x | int |
y | int |
CountBucketApiModel
Represents count data for a single time bucket.
Field | Type |
|---|---|
date | datetime.datetime |
count | int |
CountMetricResponseApiModel
Response containing count metrics as raw counts per time bucket.
Field | Type |
|---|---|
title | None | str | Unset |
data | list[CountBucketApiModel] | None | Unset |
CreateActivityParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
CreateBulkUserRequest
Request to create a new user
Field | Type |
|---|---|
first_name | str |
last_name | str |
primary_email | str |
role | str |
organization | str |
short_name | str |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
CreateCartRequest
Information used to create a plate
Field | Type |
|---|---|
name | str |
location_id | UUID |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
cellario_system_id | None | Unset | UUID |
CreateCellarioSystemRequest
Information used to create a new cellario_system
Field | Type |
|---|---|
name | str |
data_collection_default | |
data_capture_model | |
location_id | UUID |
nickname | None | str | Unset |
description | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
display_hex_color | None | str | Unset |
CreateInstructionRequest
Information to create an instruction
Field | Type |
|---|---|
name | str |
content | str |
CreateLabwareMappingCollectionRequest
Request to create a labware mapping collection
Field | Type |
|---|---|
name | None | str | Unset |
CreateLabwareMappingRequest
Request to create a labware type mapping
Field | Type |
|---|---|
external_name | str |
labware_mapping_collection_id | None | Unset | UUID |
CreateLocationRequest
Properties used to create a new location
Field | Type |
|---|---|
location_type | |
parent_location_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
image_ref | None | str | Unset |
thumbnail_ref | None | str | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
CreateManualTaskDefinitionRequest
Request model for creating a NEW manual task v2. E.g. from File >> New >> Manual Task
Field | Type |
|---|---|
name | str |
description | str |
CreateOrganizationRequest
Information used to create a new organization
Field | Type |
|---|---|
parent_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
organization_properties | list[ResourcePropertyResponse] | None | Unset |
CreateParameterTypeDescriptorRequest
Request model for creating a new parameter type descriptor.
Field | Type |
|---|---|
name | str |
type_ | |
read_only | bool |
required | bool |
display_hints | None | ParameterDisplayHintsRequest | Unset |
sub_type_id | None | Unset | UUID |
property_ids | list[UUID] | None | Unset |
validation | None | ParameterValidationRequest | Unset |
default_value | None | str | Unset |
is_library_type | bool | None | Unset |
library_type_id | None | Unset | UUID |
CreatePlateMapRequest
Request model for creating reusable plate layouts used in dose response processes
Field | Type |
|---|---|
name | str |
labware_type_id | None | Unset | UUID |
CreatePlateRequest
Information used to create a plate
Field | Type |
|---|---|
barcode | str |
labware_type_id | None | Unset | UUID |
location_id | None | Unset | UUID |
CreateProtocolParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
CreateProtocolRequest
Properties used to create a new Protocol type Activity
Field | Type |
|---|---|
organization_id | UUID |
name | str |
is_requestable | bool |
version | int |
is_validated | bool |
is_cherry_pick | bool |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
parameter_schema | CreateActivityParameterSchemaRequest | None | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
estimation_function | None | str | Unset |
CreateResourceRequest
Information used to create a new resource
Field | Type |
|---|---|
name | str |
location_id | UUID |
data_collection | |
make | None | str | Unset |
model | None | str | Unset |
variant | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
is_simulated | bool | None | Unset |
is_enabled | bool | None | Unset |
driver_package_name | None | str | Unset |
driver_version | None | str | Unset |
serial_number | None | str | Unset |
reporting_unit | None | Unset | VolumeUnit |
instructions | list[ResourceInstructionUpdateRequest] | None | Unset |
CreateRoleRequest
Request to create a user role
Field | Type |
|---|---|
organization_id | UUID |
name | None | str | Unset |
description | None | str | Unset |
alt_key | None | str | Unset |
CreateScientificProtocolRequest
Detailed information about a scientific protocol
Field | Type |
|---|---|
type_ | |
default_protocol_id | UUID |
organization_id | UUID |
name | str |
version | int |
requires_transfer_list | bool |
protocol_ids | list[UUID] | None | Unset |
description | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
ports | list[PortRequest] | None | Unset |
parameter_schema | CreateProtocolParameterSchemaRequest | None | Unset |
dilution_settings | DilutionSettings | None | Unset |
CreateTimeReservationRequest
Information used to create a new time reservation activity
Field | Type |
|---|---|
organization_id | UUID |
name | str |
is_requestable | bool |
version | int |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
parameter_schema | CreateActivityParameterSchemaRequest | None | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
cellario_system_ids | list[UUID] | None | Unset |
resource_ids | list[UUID] | None | Unset |
participants | list[SelectedParticipant] | None | Unset |
CreateUserGroupRequest
Request to create a new user group
Field | Type |
|---|---|
name | str |
description | None | str | Unset |
member_ids | list[UUID] | None | Unset |
CreateUserOrgRoleRequest
Link a user to a specific organization's role that will grant that user rights
Field | Type |
|---|---|
organization_id | UUID |
role_id | UUID |
CreateUserRequest
Request to create a new user
Field | Type |
|---|---|
first_name | str |
last_name | str |
primary_email | str |
role_id | UUID |
organization_id | UUID |
short_name | str |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
CreateWorkflowOrderRequest
Field | Type |
|---|---|
workflow_id | UUID |
workflow_version | str |
name | str |
description | str |
arguments | list[WorkflowOrderArgument] |
metadata | None | Unset | WorkflowOrderMetadata |
CreateWorkflowParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
CreateWorkflowRequest
Information for creating a workflow
Field | Type |
|---|---|
type_ | |
organization_id | UUID |
name | str |
steps | list[WorkflowStep] |
connections | list[WorkflowConnection] |
description | None | str | Unset |
image_ref | None | str | Unset |
thumbnail_ref | None | str | Unset |
parameter_schema | CreateWorkflowParameterSchemaRequest | None | Unset |
CurrentCommitmentsFilterApiModel
Filter model for querying current commitments for specific participants. Including participant type allows the service to optimize queries by only checking relevant entity tables.
Attributes:
participants (list[ParticipantIdentifier]): List of participants to get current commitments for.
Each entry includes the participant type and ID.Field | Type |
|---|---|
participants | list[ParticipantIdentifier] |
CurrentCommitmentsResponse
Response containing current commitments for the requested participants. Similar to AvailabilityResponse but focused on the current point in time.
Attributes:
commitments (list[CommitmentResponse]): List of commitments that are currently active (now falls within start-
end range).
Multiple commitments per participant are possible when a participant is working
on multiple orders simultaneously.
as_of (datetime.datetime): The point in time used to determine "current" commitmentsField | Type |
|---|---|
commitments | list[CommitmentResponse] |
as_of | datetime.datetime |
CustomerSettingRequest
Model for defining a customer setting.
Field | Type |
|---|---|
type_ | |
scope | |
value | None | str | Unset |
CustomerSettingResponse
Model to provide a customer setting value.
Field | Type |
|---|---|
type_ | |
scope | |
value | 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 |
CustomerSettingScope
Values
- DEFAULT
- GLOBAL
- USER
CustomerSettingType
Values
- DEFAULT_NOTIFICATION_RECIPIENT
- DEFAULT_RESOURCE_REGISTRATION_LOCATION_ID
- INTERMEDIATE_BARCODE_TEMPLATE
- INTERMEDIATE_PORT_NAMES
- INVALID
- MAXIMUM_CONCENTRATION_VARIANCE_PERCENT
- MAXIMUM_INTERMEDIATES
- MAXIMUM_INTERMEDIATE_VOLUME_UL
- MAXIMUM_TRANSFER_VOLUME_UL
- MAX_PERCENT_FAILED_WELLS
- MAX_PERCENT_FAILED_WELLS_INTERMEDIATE
- MINIMUM_DISPENSE_VOLUME_UL
- MINIMUM_INTERMEDIATE_VOLUME_UL
- MINIMUM_TRANSFER_VOLUME_UL
- SOLVENT_BARCODE_TEMPLATE
- SOLVENT_PORT_NAME
- TIP_BOX_BARCODE_TEMPLATE
- TIP_BOX_PORT_NAME
- TRANSFER_INCREMENT_UL
CustomerSettingTypeResponse
Model to provide customer setting type information
Field | Type |
|---|---|
type_ | |
max_scope | |
display_name | None | str | Unset |
description | None | str | Unset |
validation_constraints | list[ValidationConstraintResponse] | None | Unset |
CustomPropertyScopeEnum
Values
- ALL
- ORDER
- SAMPLE
CustomPropertyTypeEnum
Values
- BOOLEAN
- DURATION
- FILE
- FLOAT
- INTEGER
- JSON
- TEXT
- TIME
CustomSchemaPropertyRequest
A custom property with a name, data type, and potential values
Field | Type |
|---|---|
property_name | str |
is_required | bool |
default_value | str |
type_ | |
id | None | Unset | UUID |
display_name | None | str | Unset |
description | None | str | Unset |
choices_id | None | Unset | UUID |
valid_values | list[str] | None | Unset |
scope | CustomPropertyScopeEnum | None | Unset |
CustomSchemaPropertyResponse
A custom property with a name, data type, and potential values
Field | Type |
|---|---|
id | UUID |
property_name | str |
is_required | bool |
type_ | |
scope | |
display_name | None | str | Unset |
description | None | str | Unset |
default_value | None | str | Unset |
choices | ChoicesResponse | None | Unset |
valid_values | list[str] | None | Unset |
CustomSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
apply_to_all_types | bool | None | Unset |
custom_schema_properties | list[CustomSchemaPropertyRequest] | None | Unset |
CustomSchemaResponse
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
id | UUID |
apply_to_all_types | bool |
schema_type | |
name | None | str | Unset |
description | None | str | Unset |
custom_schema_properties | list[CustomSchemaPropertyResponse] | None | Unset |
DataCaptureModel
Values
- PULL
- PUSH
DeliveryResponse
Represents a specific delivery to a subscriber
Field | Type |
|---|---|
id | UUID |
state | |
subscriber_id | UUID |
event_id | UUID |
delivery_try_count | int |
subscriber | None | SubscriberResponse | Unset |
date_created | datetime.datetime | None | Unset |
date_next_delivery_try | datetime.datetime | None | Unset |
DeliveryStateEnum
Values
- BLOCKED
- CANCELED
- DELIVERED
- FAILED
- PENDING
- RETRYING
- SENDING
DeviceOperationDetailResponse
Field | Type |
|---|---|
operation_name | None | str |
description | None | str | Unset |
devices | list[DeviceOperationDeviceResponse] | None | Unset |
DeviceOperationDeviceResponse
Field | Type |
|---|---|
resource_id | UUID |
resource_name | None | str |
show_in_protocol_designer | bool |
driver | None | str | Unset |
driver_version | None | str | Unset |
parameters | list[DeviceOperationParameterResponse] | None | Unset |
DeviceOperationParameterResponse
Field | Type |
|---|---|
id | UUID |
name | None | str |
type_ | None | TaskParameterType | Unset |
required | bool | None | Unset |
default_value | None | str | Unset |
unit | None | str | Unset |
min_value | float | None | Unset |
max_value | float | None | Unset |
choices | list[str] | None | Unset |
DeviceOperationPublishRequest
Field | Type |
|---|---|
resource_ids | list[UUID] | None |
show_in_protocol_designer | bool |
DeviceOperationSummaryResponse
Field | Type |
|---|---|
operation_name | None | str |
device_count | int |
parameter_count | int |
description | None | str | Unset |
last_modified | datetime.datetime | None | Unset |
DilutionSettings
The settings used when calculating transfer volumes when dilution is required.
Field | Type |
|---|---|
minimum_transfer_volume_ul | float | None | Unset |
maximum_transfer_volume_ul | float | None | Unset |
transfer_increment_ul | float | None | Unset |
dispense_increment_ul | float | None | Unset |
maximum_concentration_variance_percent | float | None | Unset |
minimum_intermediate_volume_ul | float | None | Unset |
maximum_intermediate_volume_ul | float | None | Unset |
intermediate_barcode_template | None | str | Unset |
solvent_barcode_template | None | str | Unset |
maximum_intermediates | int | None | Unset |
intermediate_port_names | list[str] | None | Unset |
solvent_port_name | None | str | Unset |
tip_box_port_name | None | str | Unset |
tip_box_barcode_template | None | str | Unset |
DockedResourceResponse
Response model for a resource docked at a dock, including cart association
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
cart | CartMinimalResponse | None | Unset |
DockDetailResponse
Detailed response model for a dock including docked resources and carts
Field | Type |
|---|---|
id | UUID |
db_key | UUID |
dock_id | int |
is_occupied | bool |
name | None | str | Unset |
switch_address | None | str | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
location | LocationMinimalResponse | None | Unset |
docked_resources | list[DockedResourceResponse] | None | Unset |
docked_carts | list[CartMinimalResponse] | 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 |
DockResponse
Response model for a dock
Field | Type |
|---|---|
id | UUID |
db_key | UUID |
dock_id | int |
is_occupied | bool |
name | None | str | Unset |
switch_address | None | str | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
location | LocationMinimalResponse | 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 |
DurationBucketApiModel
Represents duration data for a single time bucket in raw seconds.
Field | Type |
|---|---|
date | datetime.datetime |
active | int |
in_error | int |
idle | int |
degraded | int |
degraded_depth | float |
resources_in_error | int |
DurationMetricResponseApiModel
Response containing duration metrics as raw seconds per time bucket.
Field | Type |
|---|---|
title | None | str | Unset |
data | list[DurationBucketApiModel] | None | Unset |
DurationSpec
Field | Type |
|---|---|
min_ | str |
max_ | str |
preferred | str |
DurationSpecRecord
Field | Type |
|---|---|
min_ | str |
max_ | str |
preferred | str |
ErrorEventResponse
Response for an error event
Field | Type |
|---|---|
source_type | |
type_ | |
state | |
error_count | int |
source | None | str | Unset |
resource | None | ResourceMinimalResponse | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
detail_message | None | str | 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] |
EstimationParameterResponse
Represents an available parameter for protocol duration estimation. Parameters can be used in estimation function expressions to calculate protocol durations.
Attributes:
name (None | str | Unset): Parameter name in snake_case for use in estimation functions (e.g.,
"well_transfer_count", "reagent_input_plate_count")
display_name (None | str | Unset): Human-readable display name for UI presentation (e.g., "Well Transfer Count",
"Reagent Input Plate Count")
category (None | str | Unset): Parameter category indicating the source/type of this parameter
description (None | str | Unset): Description of what this parameter represents and how it's calculated
default_value (float | None | Unset): Default value for this parameter when no work order data is available
(null if no default)Field | Type |
|---|---|
name | None | str | Unset |
display_name | None | str | Unset |
category | None | str | Unset |
description | None | str | Unset |
default_value | float | None | Unset |
EstimationResultResponse
Result of testing a protocol estimation function. Contains the calculated duration and any validation errors.
Attributes:
duration_seconds (int): Estimated duration in seconds (0 if IsValid is false)
is_valid (bool): Indicates if the estimation was successful and the function is valid
errors (list[str] | None | Unset): Validation or calculation errors (null if IsValid is true)Field | Type |
|---|---|
duration_seconds | int |
is_valid | bool |
errors | list[str] | None | Unset |
EstimationTestRequest
Request to test a protocol estimation function with specific parameter values. Used to validate and preview estimation calculations before saving to the protocol.
Attributes:
estimation_function (None | str | Unset): The estimation function expression to test (e.g., "well_transfer_count
* 2 + plate_transfer_count * 180")
parameter_values (EstimationTestRequestParameterValuesType0 | None | Unset): Parameter values to use for
testing, keyed by parameter name (e.g., {"well_transfer_count": 96, "plate_transfer_count": 1})Field | Type |
|---|---|
estimation_function | None | str | Unset |
parameter_values | EstimationTestRequestParameterValuesType0 | None | Unset |
EstimationTestRequestParameterValuesType0
Parameter values to use for testing, keyed by parameter name (e.g., {"well_transfer_count": 96, "plate_transfer_count": 1})
Field | Type |
|---|---|
additional_properties | dict[str, float] |
additional_keys | list[str] |
EventFilterIncludeType
Values
- FILE_REFERENCES
- PLATE
- PROTOCOL
- RESOURCE
- SYSTEM
EventResponse
Event information generated by a system
Field | Type |
|---|---|
id | UUID |
source | str |
source_type | |
type_ | |
state | |
generated_date | datetime.datetime |
description | None | str | Unset |
reference_id | int | None | Unset |
metadata | Any | Unset |
parameters | list[ResourcePropertyResponse] | None | Unset |
file_references | list[FileReferenceResponse] | None | Unset |
resource_id | None | Unset | UUID |
resource_name | None | str | Unset |
resource | None | ResourceMinimalResponse | Unset |
protocol_id | None | Unset | UUID |
protocol_reference_id | int | None | Unset |
protocol | None | ProtocolResponse | Unset |
operation_id | None | Unset | UUID |
operation_reference_id | int | None | Unset |
run_order_id | None | Unset | UUID |
order_reference_id | int | None | Unset |
work_order_ids | list[UUID] | None | Unset |
workflow_order_id | None | Unset | UUID |
workflow_order_step_id | None | Unset | UUID |
system_id | None | Unset | UUID |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
plate_protocol_reference_id | int | None | Unset |
sample_operation_reference_id | int | None | Unset |
order_sample_reference_id | int | None | Unset |
labware_type_id | None | Unset | UUID |
protocol_step_reference_id | int | None | Unset |
destination_resource_id | None | Unset | UUID |
destination_resource_name | None | str | Unset |
operation_resource_id | None | Unset | UUID |
operation_resource_name | None | str | Unset |
plates | list[PlateMinimalResponse] | None | Unset |
plate_reference_ids | list[int] | None | Unset |
failure_id | None | Unset | UUID |
correlation_id | None | Unset | UUID |
resource_reference_id | None | Unset | UUID |
cellario_edge_reference_id | None | Unset | UUID |
EventSort
Values
- DESCRIPTION
- DESCRIPTION_DESC
- GENERATED_DATE
- GENERATED_DATE_DESC
- SOURCE
- SOURCE_DESC
- SOURCE_TYPE
- SOURCE_TYPE_DESC
- STATE
- STATE_DESC
- TYPE
- TYPE_DESC
EventSourceType
Values
- AGENT
- CELLARIO
- CELLARIO_EDGE
- CLOUD
- DRIVER
- OTHER
EventState
Values
- ABORTED
- ACCEPTED
- ACTIVE
- BUSY
- CANCELED
- COMPLETED
- COMPLETED_NORMALLY
- COMPLETED_WITH_ERRORS
- CONNECTED
- CONNECTING
- CREATE
- DELETE
- DELETING
- DENIED
- DOING_OP
- DRAFT
- ERROR
- FAILED
- FINISHED
- IDLE
- INITIALIZED
- INITIALIZING
- IN_ERROR
- IN_PROGRESS
- NONE
- OFFLINE
- ONLINE
- PAUSED
- PAUSING
- POST_RUN_EXECUTION
- PRE_RUN_EXECUTION
- QUEUED
- READ
- READY
- READY_TO_RUN
- RELEASED
- REPEATED
- RESERVED
- REVIEW
- RUNNING
- SCANNING
- SCRIPTING
- STARTED
- STARTING
- STOPPED
- STOPPING
- SUBMITTED
- UNAVAILABLE
- UNKNOWN
- UPDATE
- WORK_IN_VALIDATION
EventType
Values
- AUDIT
- DATA
- DEADLOCK
- DRIVER
- GENERIC
- INVENTORY
- OPERATION
- ORDER
- RESOURCE
- SYSTEM
EventTypeEnum
Values
- DISPENSE
- LTR
- NONE
- PLATE_COMPLETED
- PLATE_TRANSFER_RETRIED
- WORK_ORDER_STATE_CHANGED
FailureResolution
Values
- ACCEPTED
- FINISHED
- REPEATED
- UNRESOLVED
FailureResponse
Failure information which aggregates failed system events
Field | Type |
|---|---|
id | UUID |
type_ | |
resolution | |
state | |
description | None | str | Unset |
detail_message | None | str | Unset |
events | list[EventResponse] | None | Unset |
FailureState
Values
- COMPLETE
- OPEN
FailureType
Values
- GENERIC
- OPERATION
FileReferenceResponse
Information to verify and download a file
Field | Type |
|---|---|
id | UUID |
type_ | |
sort_order | int |
status | |
source | |
date_created | datetime.datetime |
description | None | str | Unset |
reference | None | str | Unset |
reference_id | None | Unset | UUID |
bucket_name | None | str | Unset |
name | None | str | Unset |
created_by_user | None | Unset | UserMinimalResponse |
FileSource
Values
- EVENT
- USER_UPLOAD
FileStatus
Values
- CREATED
- FAILED
- PROCESSED
- PROCESSING
FileTypeEnum
Values
- CHERRY_PICK
- OTHER
- RUN_ORDER_RESULT
- TEMPLATE
FileUpdateRequest
Update an existing file reference
Field | Type |
|---|---|
sort_order | int |
status | |
description | None | str | Unset |
GenerateBarcodeRequest
Field | Type |
|---|---|
prefix_format | str |
count | int |
system_name | None | str | Unset |
GenerateBarcodeResponse
Field | Type |
|---|---|
barcodes | list[str] | None | Unset |
IdResponse1
Generic response for an ID of type T
Field | Type |
|---|---|
id | UUID |
ImportWorkflowResponse
Field | Type |
|---|---|
id | UUID |
step_count | int |
last_modified | datetime.datetime |
last_modified_by | UUID |
name | None | str | Unset |
description | None | str | Unset |
version | None | str | Unset |
status | None | str | Unset |
warnings | list[str] | None | Unset |
InstantiateManualTaskRequest
Request model for instantiating a manual task.
Field | Type |
|---|---|
order_id | UUID |
order_reference_id | int | None | Unset |
workflow_order_id | None | Unset | UUID |
workflow_order_step_id | None | Unset | UUID |
input_values | list[ParameterValueRequestModel] | None | Unset |
InstructionResourceOperationResponse
Resource operation response for instruction
Field | Type |
|---|---|
operation | None | str | Unset |
resource | None | ResourceMinimalResponse | Unset |
resource_cellario_system | CellarioSystemMinimalResponse | None | Unset |
InstructionResponse
Instruction object that describes how an operation is performed
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
content | None | str | 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 |
instruction_resource_operations | list[InstructionResourceOperationResponse] | None | Unset |
InstructionSort
Values
- DATE_CREATED
- DATE_CREATED_DESC
- NAME
- NAME_DESC
IActionResult
LabwareMappingCollectionResponse
Labware mapping collection
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
LabwareMappingInclude
Values
- COLLECTION
- LABWARE_TYPE
- NONE
LabwareMappingResponse
Labware type mapping resource
Field | Type |
|---|---|
id | UUID |
external_name | str |
labware_type_id | UUID |
labware_type | LabwareTypeNestedResponse | None | Unset |
labware_mapping_collection | LabwareMappingCollectionResponse | None | Unset |
LabwareTypeClassNestedResponse
Simplified labware-type-class for a nested response
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
LabwareTypeClassRequest
Information used to create a new Labware Type Class
Field | Type |
|---|---|
name | str |
description | None | str | Unset |
LabwareTypeClassResponse
Information about a LabwareType Class
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
description | None | str | 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 |
LabwareTypeInclude
Values
- CLASS
- MAPPINGS
- NONE
LabwareTypeListResponse
Definition for basic labware
Field | Type |
|---|---|
id | UUID |
is_locked | bool |
grip_height | float |
grip_open_offset | float |
grip_close_offset | float |
grip_force_percent | int |
robot_speed_percent | int |
height | float |
length | float |
width | float |
thickness | float |
skirt_height | float |
dry_mass | float |
dead_volume | float |
max_volume | float |
fill_volume | float |
row_count | int |
column_count | int |
seal_time_seconds | float |
seal_temp_celsius | float |
name | None | str | Unset |
manufacturer | None | str | Unset |
manufacturer_product_number | None | str | Unset |
description | None | str | Unset |
labware_display_hex_color | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
labware_type_class | LabwareTypeClassNestedResponse | None | Unset |
stack_height | float | 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 |
mappings | list[NestedLabwareMappingResponse] | None | Unset |
LabwareTypeMinimalResponse
Labware type with minimal fields
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
LabwareTypeNestedResponse
Labware type with fewer
Field | Type |
|---|---|
grip_height | float |
grip_open_offset | float |
grip_close_offset | float |
grip_force_percent | int |
robot_speed_percent | int |
height | float |
length | float |
width | float |
thickness | float |
skirt_height | float |
dry_mass | float |
dead_volume | float |
max_volume | float |
fill_volume | float |
row_count | int |
column_count | int |
seal_time_seconds | float |
seal_temp_celsius | float |
name | None | str | Unset |
manufacturer | None | str | Unset |
manufacturer_product_number | None | str | Unset |
description | None | str | Unset |
labware_display_hex_color | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
labware_type_class | LabwareTypeClassNestedResponse | None | Unset |
stack_height | float | None | Unset |
LabwareTypeRequest
Definition for basic labware
Field | Type |
|---|---|
name | str |
grip_height | float |
grip_open_offset | float |
grip_close_offset | float |
grip_force_percent | int |
robot_speed_percent | int |
height | float |
length | float |
width | float |
thickness | float |
skirt_height | float |
dry_mass | float |
dead_volume | float |
max_volume | float |
fill_volume | float |
row_count | int |
column_count | int |
seal_time_seconds | float |
seal_temp_celsius | float |
manufacturer | None | str | Unset |
manufacturer_product_number | None | str | Unset |
description | None | str | Unset |
labware_display_hex_color | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
labware_type_class_id | None | Unset | UUID |
stack_height | float | None | Unset |
custom_properties | LabwareTypeRequestCustomPropertiesType0 | None | Unset |
LabwareTypeRequestCustomPropertiesType0
List of customer defined properties
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
LabwareTypeResponse
Definition for basic labware
Field | Type |
|---|---|
id | UUID |
is_locked | bool |
grip_height | float |
grip_open_offset | float |
grip_close_offset | float |
grip_force_percent | int |
robot_speed_percent | int |
height | float |
length | float |
width | float |
thickness | float |
skirt_height | float |
dry_mass | float |
dead_volume | float |
max_volume | float |
fill_volume | float |
row_count | int |
column_count | int |
seal_time_seconds | float |
seal_temp_celsius | float |
name | None | str | Unset |
manufacturer | None | str | Unset |
manufacturer_product_number | None | str | Unset |
description | None | str | Unset |
labware_display_hex_color | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
labware_type_class | LabwareTypeClassNestedResponse | None | Unset |
stack_height | float | 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 |
mappings | list[NestedLabwareMappingResponse] | None | Unset |
systems | list[CellarioSystemMinimalResponse] | None | Unset |
custom_properties | LabwareTypeResponseCustomPropertiesType0 | None | Unset |
LabwareTypeResponseCustomPropertiesType0
List of customer defined properties
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
LabwareTypeSort
Values
- DENSITY
- DENSITY_DESC
- DESCRIPTION
- DESCRIPTION_DESC
- LABWARE_TYPE_CLASS
- LABWARE_TYPE_CLASS_DESC
- MANUFACTURER
- MANUFACTURER_DESC
- NAME
- NAME_DESC
LabwareTypeSystemRequest
Definition for basic labware
Field | Type |
|---|---|
grip_height | float |
robot_speed_percent | int |
height | float |
thickness | float |
dry_mass | float |
fill_volume | float |
max_volume | float |
stack_height | float |
description | None | str | Unset |
labware_display_hex_color | None | str | Unset |
LabConfigurationResponse
Represents a possible laboratory configuration for scheduling work
Field | Type |
|---|---|
required_participant_ids | list[UUID] |
conditions | list[ConfigurationCondition] |
estimated_duration_seconds | int | None | Unset |
LabOverviewNode
Represents a node in the lab overview hierarchy tree. The Cellario.Cloud.Data.Api.Models.LabOverview.LabOverviewNode.Type discriminator determines which type-specific properties are populated.
Attributes:
type_ (ParticipantType):
id (UUID): Unique identifier of the participant
location_id (UUID): Identifier of the location this participant belongs to
children (list[LabOverviewNode]): Child nodes in the hierarchy
name (None | str | Unset): Display name of the participant
description (None | str | Unset): Optional description of the participant
location_type (LocationTypeEnum | None | Unset): Type of location. Only populated for Location nodes.
parent_location_id (None | Unset | UUID): Parent location ID for nested locations
nickname (None | str | Unset): Short name or alias. Populated for System and FlexCart nodes.
system_state (None | SystemState | Unset): Current operational state. Populated for System and FlexCart nodes.
alert_state (None | SystemAlertState | Unset): Alert state. Populated for System and FlexCart nodes.
cloud_connectivity (CloudConnectivityState | None | Unset): Cloud connectivity state. Populated for System and
FlexCart nodes.
cellario_version (None | str | Unset): Cellario software version. Populated for System and FlexCart nodes.
dock_id (int | None | Unset): Dock identifier. Only populated for Dock nodes.
is_occupied (bool | None | Unset): Whether the dock is currently occupied. Only populated for Dock nodes.
connection_state (CartConnectionState | None | Unset): Cart connection state. Only populated for Cart nodes.
is_docked (bool | None | Unset): Whether the cart or resource is currently docked. Populated for Cart and
Resource nodes.
current_dock_id (None | Unset | UUID): Dock ID the cart or resource is currently connected to. Populated for
Cart and Resource nodes.
resource_state (None | ResourceState | Unset): Current resource state. Only populated for Resource nodes.
cart_id (None | Unset | UUID): Associated cart ID. Only populated for Resource nodes.
driver_version (None | str | Unset): Device driver version. Only populated for Resource nodes.Field | Type |
|---|---|
type_ | |
id | UUID |
location_id | UUID |
children | list[LabOverviewNode] |
name | None | str | Unset |
description | None | str | Unset |
location_type | LocationTypeEnum | None | Unset |
parent_location_id | None | Unset | UUID |
nickname | None | str | Unset |
system_state | None | SystemState | Unset |
alert_state | None | SystemAlertState | Unset |
cloud_connectivity | CloudConnectivityState | None | Unset |
cellario_version | None | str | Unset |
dock_id | int | None | Unset |
is_occupied | bool | None | Unset |
connection_state | CartConnectionState | None | Unset |
is_docked | bool | None | Unset |
current_dock_id | None | Unset | UUID |
resource_state | None | ResourceState | Unset |
cart_id | None | Unset | UUID |
driver_version | None | str | Unset |
LabOverviewResponse
Root response for the lab overview API providing a hierarchical view of lab equipment
Field | Type |
|---|---|
locations | list[LabOverviewNode] |
summary | |
retrieved_at | datetime.datetime |
LabOverviewSummary
Aggregate counts for the lab overview
Field | Type |
|---|---|
total_systems | int |
online_systems | int |
total_resources | int |
error_resources | int |
total_carts | int |
docked_carts | int |
total_flex_carts | int |
docked_flex_carts | int |
total_docks | int |
occupied_docks | int |
LinkParametersToTaskVersionRequest
Request model for linking parameters to a manual task version. Replaces all existing parameters with the provided lists.
Attributes:
inputs (list[ManualTaskVersionParameterRequest] | None | Unset): The input parameters to link to the task
version.
This will replace all existing input parameters.
outputs (list[ManualTaskVersionParameterRequest] | None | Unset): The output parameters to link to the task
version.
This will replace all existing output parameters.Field | Type |
|---|---|
inputs | list[ManualTaskVersionParameterRequest] | None | Unset |
outputs | list[ManualTaskVersionParameterRequest] | None | Unset |
LocationDetailsResponse
Fully detailed location response
Field | Type |
|---|---|
id | UUID |
location_type | |
parent_location_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
image_ref | None | str | Unset |
thumbnail_ref | None | str | Unset |
children | list[LocationDetailsResponse] | None | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
LocationMinimalResponse
Name and Id minimal response for a Location
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
LocationSort
Values
- DESCRIPTION
- DESCRIPTION_DESC
- LOCATION_TYPE
- LOCATION_TYPE_DESC
- NAME
- NAME_DESC
- PARENT_LOCATION_NAME
- PARENT_LOCATION_NAME_DESC
LocationTypeEnum
Values
- BUILDING
- CAMPUS
- FLOOR
- LAB
- ROOM
- WORK_CELL
ManualStepCommentResponse
Response model for a task comment.
Field | Type |
|---|---|
content | str |
created_at | datetime.datetime |
created_by_id | UUID |
created_by | None | Unset | UserResponse |
ManualStepDefinitionRequestModel
Request model for a manual step v2.
Field | Type |
|---|---|
name | str |
document | str |
index | int |
required | bool |
id | None | Unset | UUID |
form_bindings | list[UUID] | None | Unset |
comments | list[str] | None | Unset |
ManualStepDefinitionResponse
Response model for a manual step v2.
Field | Type |
|---|---|
id | UUID |
name | str |
document | str |
index | int |
required | bool |
form_bindings | list[UUID] | None | Unset |
comments | list[ManualStepCommentResponse] | None | Unset |
file_attachments | list[FileReferenceResponse] | None | Unset |
ManualStepInstanceResponse
Response model for a manual step instance with state information
Field | Type |
|---|---|
id | UUID |
step_definition_id | UUID |
index | int |
state | |
completed_by_user_id | None | Unset | UUID |
date_completed | datetime.datetime | None | Unset |
output_data | None | str | Unset |
file_attachments | list[FileReferenceResponse] | None | Unset |
ManualStepState
Values
- CANCELED
- FINISHED
- READY
- SKIPPED
ManualTaskDefinitionListResponse
Response model for listing manual tasks.
Field | Type |
|---|---|
task_id | UUID |
is_latest | bool |
is_draft | bool |
is_active | bool |
is_archived | bool |
version | None | str | Unset |
available_versions | list[str] | None | Unset |
name | None | str | Unset |
description | None | str | Unset |
framework_version | None | str | Unset |
date_created | datetime.datetime | None | Unset |
last_modified | datetime.datetime | None | Unset |
created_by_user_id | None | Unset | UUID |
last_modified_by_user_id | None | Unset | UUID |
ManualTaskDefinitionResponse
Response model for a manual task v2.
Field | Type |
|---|---|
task_id | UUID |
version | str |
name | str |
framework_version | str |
steps | list[ManualStepDefinitionResponse] |
inputs | list[ManualTaskParameterResponse] |
outputs | list[ManualTaskParameterResponse] |
comments_enabled | bool |
is_draft | bool |
is_latest | bool |
is_active | bool |
is_archived | bool |
description | None | str | Unset |
date_created | datetime.datetime | None | Unset |
last_modified | datetime.datetime | None | Unset |
created_by_user_id | None | Unset | UUID |
last_modified_by_user_id | None | Unset | UUID |
ManualTaskDefinitionSort
Values
- CREATED_BY
- CREATED_BY_DESC
- DATE_CREATED
- DATE_CREATED_DESC
- DATE_LAST_MODIFIED
- DATE_LAST_MODIFIED_DESC
- NAME
- NAME_DESC
ManualTaskDefinitionStatus
Values
- ARCHIVED
- DRAFT
- PUBLISHED
ManualTaskInstanceCountsResponse
Count of manual task instances matching the supplied filter, grouped by state. Buckets are mutually exclusive and sum to Cellario.Cloud.Data.Api.Models.ManualTasks.Instances.ManualTaskInstanceCountsResponse.Total.
Attributes:
ready (int): Instances in `READY` state — created and waiting to start.
started (int): Instances in `STARTED` state — in progress.
finished (int): Instances in `FINISHED` state — completed successfully.
failed (int): Instances in `FAILED` state — terminated with an error.
canceled (int): Instances in `CANCELED` state — explicitly canceled.
skipped (int): Instances in `SKIPPED` state — bypassed (e.g., conditional branch not taken).
total (int): Total number of instances matching the filter. Equals the sum of the per-state buckets.Field | Type |
|---|---|
ready | int |
started | int |
finished | int |
failed | int |
canceled | int |
skipped | int |
total | int |
ManualTaskInstanceListResponse
Response model for listing runnable/running manual tasks.
Field | Type |
|---|---|
task_id | UUID |
definition_id | UUID |
version | str |
name | str |
description | str |
framework_version | str |
state | |
date_created | datetime.datetime | None | Unset |
created_by_user_id | None | Unset | UUID |
assigned_to_user_id | None | Unset | UUID |
order_id | None | Unset | UUID |
workflow_order_id | None | Unset | UUID |
workflow_order_step_id | None | Unset | UUID |
runtime_id | None | str | Unset |
date_started | datetime.datetime | None | Unset |
date_completed | datetime.datetime | None | Unset |
started_by_user_id | None | Unset | UUID |
completed_by_user_id | None | Unset | UUID |
cancellation_reason | None | str | Unset |
ManualTaskInstanceResponse
Response model for a manual task instance. This is a runnable manual task that is created from a definition.
Attributes:
task_id (UUID): The unique identifier of the manual task instance.
definition_id (UUID): The unique identifier of the definition from which the manual task instance is copied.
version (str): The version of the definition from which the manual task instance is created.
framework_version (str): The framework version of the manual task.
state (ManualTaskState):
steps (list[ManualTaskInstanceStepResponse]): The step instances for this manual task.
inputs (list[ManualTaskParameterResponse]): The input parameter values for this task instance.
outputs (list[ManualTaskParameterResponse]): The output parameter values for this task instance.
name (None | str | Unset): The name of the manual task.
description (None | str | Unset): The description of the manual task.
assigned_to_user_id (None | Unset | UUID): The ID of the user to whom the manual task instance is assigned.
order_id (None | Unset | UUID): The ID of the workflow order that is the parent of the manual task instance.
workflow_order_id (None | Unset | UUID): The workflow order ID associated with this task instance.
workflow_order_step_id (None | Unset | UUID): The workflow order step ID associated with this task instance.
runtime_id (None | str | Unset): Opaque runtime ID under which the manual task instance is created.
date_created (datetime.datetime | None | Unset): The date and time when the manual task was created.
created_by_user_id (None | Unset | UUID): The ID of the user who created the manual task.
last_modified (datetime.datetime | None | Unset): The date and time when the manual task was last modified.
last_modified_by_user_id (None | Unset | UUID): The ID of the user who last modified the manual task.
date_completed (datetime.datetime | None | Unset): The date and time when the manual task was completed
started_by_user_id (None | Unset | UUID): The ID of the user who started the manual task.
completed_by_user_id (None | Unset | UUID): The ID of the user who completed or cancelled the manual task.
cancellation_reason (None | str | Unset): The reason provided when the manual task was cancelled.Field | Type |
|---|---|
task_id | UUID |
definition_id | UUID |
version | str |
framework_version | str |
state | |
steps | |
inputs | list[ManualTaskParameterResponse] |
outputs | list[ManualTaskParameterResponse] |
name | None | str | Unset |
description | None | str | Unset |
assigned_to_user_id | None | Unset | UUID |
order_id | None | Unset | UUID |
workflow_order_id | None | Unset | UUID |
workflow_order_step_id | None | Unset | UUID |
runtime_id | None | str | Unset |
date_created | datetime.datetime | None | Unset |
created_by_user_id | None | Unset | UUID |
last_modified | datetime.datetime | None | Unset |
last_modified_by_user_id | None | Unset | UUID |
date_completed | datetime.datetime | None | Unset |
started_by_user_id | None | Unset | UUID |
completed_by_user_id | None | Unset | UUID |
cancellation_reason | None | str | Unset |
ManualTaskInstanceSort
Values
- DATE_COMPLETED
- DATE_COMPLETED_DESC
- DATE_CREATED
- DATE_CREATED_DESC
- DATE_STARTED
- DATE_STARTED_DESC
- NAME
- NAME_DESC
- STATE
- STATE_DESC
ManualTaskInstanceStepResponse
Response model for a step within a manual task instance. Contains both the instance-specific data and reference to the definition.
Attributes:
id (UUID): The unique identifier of the step instance.
step_definition_id (UUID): The ID of the step definition this instance was created from.
index (int): The order/position of this step within the task (0-based).
state (ManualStepState):
required (bool): Indicates whether this step is required (from the definition).
name (None | str | Unset): The name of the step (from the definition).
document (None | str | Unset): The document content for this step (from the definition).
form_bindings (list[UUID] | None | Unset): The form bindings for this step (from the definition).
comments (list[ManualStepCommentResponse] | None | Unset): Comments associated with this step (from the
definition).
completed_by_user_id (None | Unset | UUID): The ID of the user who completed this step.
date_completed (datetime.datetime | None | Unset): The date and time when this step was completed.
output_data (None | str | Unset): Any output data from this step instance.
file_attachments (list[FileReferenceResponse] | None | Unset): File attachments associated with this step (from
the definition).Field | Type |
|---|---|
id | UUID |
step_definition_id | UUID |
index | int |
state | |
required | bool |
name | None | str | Unset |
document | None | str | Unset |
form_bindings | list[UUID] | None | Unset |
comments | list[ManualStepCommentResponse] | None | Unset |
completed_by_user_id | None | Unset | UUID |
date_completed | datetime.datetime | None | Unset |
output_data | None | str | Unset |
file_attachments | list[FileReferenceResponse] | None | Unset |
ManualTaskParameterResponse
Unified response model for manual task parameters used in both definitions and instances.
Field | Type |
|---|---|
id | UUID |
index | int |
type_descriptor_id | UUID |
name | str |
type_ | |
read_only | bool |
required | bool |
properties | |
is_active | bool |
revision | int |
value | None | str | Unset |
display_hints | None | ParameterDisplayHintsResponse | Unset |
sub_type | None | ParameterTypeDescriptorResponse | Unset |
order | int | None | Unset |
validation | None | ParameterValidationResponse | Unset |
default_value | None | str | Unset |
library_type_id | None | Unset | UUID |
related_parameter_id | None | Unset | UUID |
value_set_by_user_id | None | Unset | UUID |
ManualTaskState
Values
- CANCELED
- FAILED
- FINISHED
- READY
- SKIPPED
- STARTED
ManualTaskStepUploadFileFilesBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
ManualTaskStepUploadFileJsonBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
ManualTaskVersionsListResponse
Response model for listing manual task versions.
Field | Type |
|---|---|
versions | list[str] | None | Unset |
ManualTaskVersionDefinitionRequestModel
Request model for a manual task v2.
Field | Type |
|---|---|
steps | |
comments_enabled | bool |
framework_version | None | str | Unset |
ManualTaskVersionParametersResponse
Response model for manual task version parameters.
Field | Type |
|---|---|
task_id | UUID |
version | None | str | Unset |
inputs | list[ManualTaskParameterResponse] | None | Unset |
outputs | list[ManualTaskParameterResponse] | None | Unset |
ManualTaskVersionParameterRequest
Linking Parameters Type Descriptor to Manual Task Version with specific context to create Manual Task Version Parameters
Attributes:
parameter_type_descriptor_id (UUID): The unique identifier of the parameter type descriptor.
index (int): The order/position of this parameter in the task.
is_output (bool): Flag indicating whether this is an output parameter (false = input).
parameter_id (None | Unset | UUID): The stable identifier of the parameter that persists across versions
(optional, used for updates).
If provided, updates an existing parameter. If null, creates a new parameter.
related_parameter_id (None | Unset | UUID): Optional stable ParameterId of a related input parameter.
Only applicable for output parameters. When set, the output's value will be
seeded from the related input parameter's value during task instantiation.Field | Type |
|---|---|
parameter_type_descriptor_id | UUID |
index | int |
is_output | bool |
parameter_id | None | Unset | UUID |
related_parameter_id | None | Unset | UUID |
MetricEntityTagType
Values
- CART
- LOCATION
- ORDER
- PLATE
- PROTOCOL
- RESOURCE
- SYSTEM
MetricInterval
Values
- DAILY
- FIFTEEN_MINUTE
- HOURLY
- MONTHLY
- WEEKLY
MetricMeasurementType
Values
- ACTIVITY
- GAUGE
MetricRelatedEntityResponse
Tag information for an entity that is connected to a metric
Field | Type |
|---|---|
tag_type | |
id | UUID |
name | None | str | Unset |
MetricResponseApiModel
Represents a particular metric being measured over a period of time
Field | Type |
|---|---|
type_ | |
data | list[TimeSeriesDataApiModel] | None | Unset |
related_entites | list[MetricRelatedEntityResponse] | None | Unset |
MetricType
Values
- CART_UTILIZATION
- EVENTS_GENERATED
- OPERATIONS_PROCESSED
- PLATES_PROCESSED
- RESOURCE_UTILIZATION
- SYSTEM_RESOURCE_UTILIZATION
- SYSTEM_UTILIZATION
MisconfigurationDetail
Field | Type |
|---|---|
participant_id | UUID |
participant_name | str |
participant_type | |
reason | |
expected_system_id | None | Unset | UUID |
expected_system_name | None | str | Unset |
actual_system_id | None | Unset | UUID |
actual_system_name | None | str | Unset |
MisconfigurationReason
Values
- DOCKED_TO_WRONG_SYSTEM
- NO_CONSENSUS
- PARTICIPANT_NOT_FOUND
- RESOURCE_ON_WRONG_SYSTEM
- UNDOCKED_FROM_EXPECTED_SYSTEM
MoveTaskResponse
Task to move a plate from one position to another
Field | Type |
|---|---|
id | UUID |
run_order | |
state | |
history | list[AuditActionResponse] |
instructions | list[InstructionResponse] |
is_scan_barcode_required | bool |
step_notes | None | str | Unset |
notes | None | str | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
work_order | None | Unset | WorkOrderMinimalResponse |
barcode | None | str | Unset |
current_position | None | ResourcePositionResponse | Unset |
destination_position | None | ResourcePositionResponse | Unset |
NestedLabwareMappingResponse
Labware type mapping resource
Field | Type |
|---|---|
id | UUID |
external_name | str |
labware_mapping_collection | LabwareMappingCollectionResponse | None | Unset |
OperationAction
Values
- ABORT
- ACCEPT
- REPEAT
OperationParameterResponse
A parameter for a resource operation, with resolved type and metadata.
Field | Type |
|---|---|
id | UUID |
name | None | str |
parameter_type_descriptor_id | UUID |
type_ | None | TaskParameterType | Unset |
required | bool | None | Unset |
default_value | None | str | Unset |
unit | None | str | Unset |
example_value | None | str | Unset |
min_value | float | None | Unset |
max_value | float | None | Unset |
choices | list[str] | None | Unset |
OperationResponse
Information about a resource's operation
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
publish_status | None | ResourceOperationPublishStatus | Unset |
parameters | list[OperationParameterResponse] | None | Unset |
revision | int | None | Unset |
driver_version | None | str | Unset |
description | None | str | Unset |
show_in_protocol_designer | bool | None | Unset |
simulation_time | int | None | Unset |
time_out_time | int | None | Unset |
OperationState
Values
- ACCEPT
- FAILED
- FINISHED
- NONE
- REPEAT
- STARTED
OperationTaskResponse
Operation to perform an action on a resource
Field | Type |
|---|---|
id | UUID |
run_order | |
state | |
history | list[AuditActionResponse] |
instructions | list[InstructionResponse] |
barcodes | list[str] |
resource | |
parameters | list[ResourcePropertyResponse] |
step_notes | None | str | Unset |
notes | None | str | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
work_order | None | Unset | WorkOrderMinimalResponse |
name | None | str | Unset |
location | LocationMinimalResponse | None | Unset |
OrderCommentResponse
Represents a comment on an order
Field | Type |
|---|---|
id | UUID |
order_id | UUID |
comment | CommentResponse | None | Unset |
OrderStateEnum
Values
- ACTIVE
- CANCELED
- COMPLETED
- DELETED
- DENIED
- DRAFT
- FINISHED
- NONE
- PAUSED
- PAUSING
- POST_RUN_EXECUTION
- PRE_RUN_EXECUTION
- READY_TO_RUN
- RELEASED
- RESERVED
- SCANNING
- SCRIPTING
- STARTING
- SUBMITTED
- WORK_IN_VALIDATION
OrderStateResponse
Order state response
Field | Type |
|---|---|
state | |
id | UUID |
name | None | str | Unset |
description | None | str | Unset |
alt_key | None | str | Unset |
OrderTemplateStepType
Values
- INCUBATE
- INPUT
- NONE
- OUTPUT
OrderTransitionResponse
Response for a state transition request
Field | Type |
|---|---|
state | |
is_deleted | bool |
OrderUpdateStateRequest
Request to update the state of an order
Field | Type |
|---|---|
state |
OrganizationDetailsResponse
Object that describes an organization
Field | Type |
|---|---|
id | UUID |
parent_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
image_ref | None | str | Unset |
thumbnail_ref | None | str | Unset |
organization_properties | list[ResourcePropertyResponse] | None | Unset |
OrganizationListItemResponse
Object that describes an organization
Field | Type |
|---|---|
id | UUID |
parent_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
type_name | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
organization_properties | list[ResourcePropertyResponse] | None | Unset |
ParameterDescriptorFormat
Values
- DATE
- DATE_TIME
- FILE
- NONE
- TIME
- URL
ParameterDisplayHintsRequest
Request model for creating parameter display hints.
Field | Type |
|---|---|
label | None | str | Unset |
description | None | str | Unset |
widget | None | Unset | WidgetType |
ParameterDisplayHintsResponse
Response model for parameter display hints.
Field | Type |
|---|---|
id | UUID |
label | None | str | Unset |
description | None | str | Unset |
widget | None | Unset | WidgetType |
ParameterTypeDescriptorListResponse
Response model for parameter type descriptor list items.
Field | Type |
|---|---|
id | UUID |
name | str |
type_ | str |
is_active | bool |
is_library_type | bool |
library_type_id | None | Unset | UUID |
default_value | None | str | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
ParameterTypeDescriptorResponse
Response model for parameter type descriptor.
Field | Type |
|---|---|
id | UUID |
name | str |
type_ | |
read_only | bool |
required | bool |
properties | |
is_active | bool |
is_library_type | bool |
type_descriptor_group_id | UUID |
revision | int |
display_hints | None | ParameterDisplayHintsResponse | Unset |
sub_type | None | ParameterTypeDescriptorResponse | Unset |
parent_type_descriptor_id | None | Unset | UUID |
order | int | None | Unset |
validation | None | ParameterValidationResponse | Unset |
default_value | None | str | Unset |
library_type_id | None | Unset | UUID |
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 |
ParameterValidationRequest
Request model for creating parameter validation rules.
Field | Type |
|---|---|
regex_pattern | None | str | Unset |
format_ | None | ParameterDescriptorFormat | Unset |
min_length | int | None | Unset |
max_length | int | None | Unset |
choices | list[str] | None | Unset |
min_value | float | None | Unset |
max_value | float | None | Unset |
step | float | None | Unset |
ParameterValidationResponse
Response model for parameter validation rules.
Field | Type |
|---|---|
id | UUID |
regex_pattern | None | str | Unset |
format_ | None | ParameterDescriptorFormat | Unset |
min_length | int | None | Unset |
max_length | int | None | Unset |
choices | list[str] | None | Unset |
min_value | float | None | Unset |
max_value | float | None | Unset |
step | float | None | Unset |
ParameterValueRequestModel
Request model for providing a parameter value for a manual task instance.
Field | Type |
|---|---|
parameter_id | UUID |
value | str |
ParticipantCommitmentSnapshot
Field | Type |
|---|---|
commitment_id | UUID |
participant_id | UUID |
start_time | datetime.datetime |
end_time | datetime.datetime |
calendar_entry_id | None | Unset | UUID |
source_workflow_order_id | None | Unset | UUID |
ParticipantIdentifier
Identifies a participant by type and ID for optimized commitment lookups
Field | Type |
|---|---|
type_ | |
id | UUID |
ParticipantPoolRecord
Field | Type |
|---|---|
candidate_participant_ids | list[UUID] |
count_required | int |
ParticipantResponse
Represents a participant that can be booked on a calendar
Field | Type |
|---|---|
id | UUID |
name | str |
type_ | |
parent_id | None | Unset | UUID |
scheduling_constraint | None | SchedulingConstraintType | Unset |
display_hex_color | None | str | Unset |
ParticipantType
Values
- CART
- DOCK
- FLEX_CART
- LOCATION
- RESOURCE
- SYSTEM
ParticipantWindow
Field | Type |
|---|---|
participant_id | UUID |
offset | str |
duration |
PatchActivityParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
schema_type | |
description | None | str | Unset |
name | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
PatchTimeReservationRequest
Information used to patch a time reservation activity
Field | Type |
|---|---|
description | None | str | Unset |
image_ref | None | str | Unset |
is_requestable | bool | None | Unset |
name | None | str | Unset |
organization_id | None | Unset | UUID |
parameter_schema | None | PatchActivityParameterSchemaRequest | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
version | int | None | Unset |
cellario_system_ids | list[UUID] | None | Unset |
resource_ids | list[UUID] | None | Unset |
participants | list[SelectedParticipant] | None | Unset |
PlacementResult
Field | Type |
|---|---|
parent_calendar_entry_id | UUID |
child_calendar_entry_ids | list[UUID] |
conflict_warnings | list[ConflictDetail] |
PlateBarcodeRelationshipResponse
Source barcode to destination barcode relationship
Field | Type |
|---|---|
is_dispense | bool |
source_barcode | None | str | Unset |
destination_barcode | None | str | Unset |
PlateCreateOrUpdateRequest
Information used to create a plate
Field | Type |
|---|---|
barcode | None | str | Unset |
labware_type_id | None | Unset | UUID |
location_id | None | Unset | UUID |
id | None | Unset | UUID |
PlateDelayOption
Values
- ALL
- ALL_EXCEPT_FIRST
- BATCH_DELAY
- FIRST_ONLY
- PREVIOUS_FINISHED
PlateMapResponse
Response model containing plate map template data for reusable layouts in dose response processes
Field | Type |
|---|---|
id | UUID |
version | int |
name | None | str | Unset |
labware_type | LabwareTypeMinimalResponse | None | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
PlateMinimalResponse
Model to describe a plate which represents the physical objects that are processed in a laboratory
Field | Type |
|---|---|
id | UUID |
barcode | None | str | Unset |
labware_type | LabwareTypeMinimalResponse | None | Unset |
location | LocationMinimalResponse | None | Unset |
PlateParametersRequest
Request to add parameters to a specific plate in a work order
Field | Type |
|---|---|
barcode | str |
plate_parameters |
PlateRelationsInclude
Values
- INTERMEDIATE_PLATES
- RELATIONSHIPS
PlateRelationsResponse
Returns each grouping of plates in a work order that are dependent on each other for full transfers
Field | Type |
|---|---|
plate_relations | list[PlateRelationResponse] | None | Unset |
PlateRelationResponse
Source and destination plate set of a full transfer
Field | Type |
|---|---|
transfer_state | |
sources | list[str] | None | Unset |
destinations | list[str] | None | Unset |
relationships | list[PlateBarcodeRelationshipResponse] | None | Unset |
PlateRelationTransferState
Values
- ACTIVE
- AVAILABLE
- FINISHED
- RESERVED
PlateResponse
Model to describe a plate which represents the physical objects that are processed in a laboratory
Field | Type |
|---|---|
id | UUID |
barcode | None | str | Unset |
labware_type | LabwareTypeMinimalResponse | None | Unset |
location | LocationMinimalResponse | 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 |
PlateTransfersCreateRequest
Set of transfers to be performed from a source plate (or dispenser) to a destination plate
Field | Type |
|---|---|
destination_plate_barcode | str |
transfers | list[TransferCreateRequest] |
source_plate_barcode | None | str | Unset |
PlateTransfersFilterApiModel
Filter model for Get transfers
Field | Type |
|---|---|
connected_to_plate_transfer_ids | list[UUID] |
barcodes | list[str] | None | Unset |
include | list[PlateTransfersInclude] | None | Unset |
page | int | None | Unset |
page_size | int | None | Unset |
PlateTransfersInclude
Values
- DESTINATION_PORT_PLATE
- TRANSFERS
PlateTransfersResponse
Set of transfers to be performed from a source plate (or dispenser) to a destination plate
Field | Type |
|---|---|
id | UUID |
state | |
destination_port_plate | |
transfers | list[TransferResponse] |
requested_transfers | list[TransferResponse] |
source_port_plate | None | PortPlateResponse | Unset |
run_order_id | None | Unset | UUID |
retried_by_plate_transfer_id | None | Unset | UUID |
tip_port_plate | None | PortPlateResponse | Unset |
PlateTransferState
Values
- FAILED
- NONE
- PASSED
- REVIEW
- STARTED
PoolClaim
Field | Type |
|---|---|
candidate_ids | list[UUID] |
count_required | int |
offset | str |
duration |
PoolClaimSnapshot
Field | Type |
|---|---|
calendar_entry_id | UUID |
candidate_participant_ids | list[UUID] |
count_required | int |
start_time | datetime.datetime |
end_time | datetime.datetime |
source_workflow_order_id | None | Unset | UUID |
PortPlateRequest
Associate plates to a port
Field | Type |
|---|---|
plate | |
port_id | UUID |
id | None | Unset | UUID |
sort_order | int | None | Unset |
PortPlateResponse
Associate plates to a port
Field | Type |
|---|---|
id | UUID |
plate | |
port | |
sort_order | int | None | Unset |
PortRequest
Create a port
Field | Type |
|---|---|
type_ | |
name | None | str | Unset |
description | None | str | Unset |
PortResponse
Protocol port
Field | Type |
|---|---|
id | UUID |
type_ | |
is_optional | bool |
name | None | str | Unset |
description | None | str | Unset |
PortType
Values
- INPUT
- NONE
- OUTPUT
PortTypeEnum
Values
- INPUT
- NONE
- 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] |
ProtocolEstimationParametersResponse
Complete estimation configuration for a protocol, including available parameters and estimation functions. Used by the UI to build the estimation calculator interface.
Attributes:
protocol_id (UUID): Protocol ID
available_parameters (list[EstimationParameterResponse] | None | Unset): All parameters available for use in
estimation functions for this protocol
default_estimation_function (None | str | Unset): The default estimation function auto-generated from protocol
structure.
Used when CurrentEstimationFunction is null.
current_estimation_function (None | str | Unset): The current custom estimation function saved to this protocol.
null indicates the protocol is using the DefaultEstimationFunction.Field | Type |
|---|---|
protocol_id | UUID |
available_parameters | list[EstimationParameterResponse] | None | Unset |
default_estimation_function | None | str | Unset |
current_estimation_function | None | str | Unset |
ProtocolEstimationResultResponse
Result of estimating duration for a work order using its actual data. Includes the calculated duration and all parameter values that were resolved from the work order.
Attributes:
work_order_id (UUID): The work order ID that was estimated
estimated_duration_seconds (int): Estimated duration in seconds based on actual work order data
estimation_function_used (None | str | Unset): The estimation function expression that was evaluated (custom,
protocol, or default)
parameter_values_used (None | ProtocolEstimationResultResponseParameterValuesUsedType0 | Unset): The actual
parameter values resolved from work order data and used in the calculation.
Keys are parameter names (e.g., "reagent_input_plate_count"), values are the resolved numeric values.Field | Type |
|---|---|
work_order_id | UUID |
estimated_duration_seconds | int |
estimation_function_used | None | str | Unset |
parameter_values_used | None | ProtocolEstimationResultResponseParameterValuesUsedType0 | Unset |
ProtocolEstimationResultResponseParameterValuesUsedType0
The actual parameter values resolved from work order data and used in the calculation. Keys are parameter names (e.g., "reagent_input_plate_count"), values are the resolved numeric values.
Field | Type |
|---|---|
additional_properties | dict[str, float] |
additional_keys | list[str] |
ProtocolInclude
Values
- NONE
- SYSTEM_DETAILS
ProtocolListItemResponse
Information returned about a protocol when
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
is_published | bool |
version | int |
is_validated | bool |
is_cherry_pick | bool |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | 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 |
parameter_schema | CustomSchemaResponse | None | Unset |
compatible_systems | list[UUID] | None | Unset |
system_assignments | list[CellarioSystemMinimalResponse] | None | Unset |
ProtocolParameterLevel
Values
- ORDER
- SAMPLE
ProtocolParameterSchemaResponse
Protocol parameters
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyResponse] | None | Unset |
ProtocolParameterType
Values
- BOOL
- DATE_TIME
- DURATION
- FILE
- NUMBER
- STRING
ProtocolResourceReservationRequest
Request model for creating/updating a protocol resource reservation
Field | Type |
|---|---|
resource_id | UUID |
is_ignored | bool |
reservation_segments | list[ReservationSegmentRequest] | None | Unset |
ProtocolResourceReservationResponse
Response model for a protocol resource reservation
Field | Type |
|---|---|
id | UUID |
protocol_id | UUID |
resource_id | UUID |
is_ignored | bool |
resource_name | None | str | Unset |
reservation_segments | list[ReservationSegmentResponse] | None | 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 |
ProtocolResponse
Detailed information about a protocol
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
version | int |
is_validated | bool |
is_cherry_pick | bool |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
is_published | bool | None | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
files | list[FileReferenceResponse] | None | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | 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 |
properties | list[ResourcePropertyResponse] | None | Unset |
estimation_function | None | str | Unset |
lab_protocol | CellarioProtocol | None | Unset |
lab_order_templates | list[CellarioOrderTemplate] | None | Unset |
system_assignments | list[ProtocolSystemAssignmentResponse] | None | Unset |
resource_reservations | list[ProtocolResourceReservationResponse] | None | Unset |
ProtocolSort
Values
- DESCRIPTION
- DESCRIPTION_DESC
- IS_REQUESTABLE
- IS_REQUESTABLE_DESC
- IS_VALIDATED
- IS_VALIDATED_DESC
- NAME
- NAME_DESC
- REFERENCE_ID
- REFERENCE_ID_DESC
- VERSION
- VERSION_DESC
ProtocolSystemAssignmentResponse
The link between a system and a protocol
Field | Type |
|---|---|
id | UUID |
cellario_system | CellarioSystemResponse | None | Unset |
protocol | None | ProtocolResponse | Unset |
PublishingEventResponse
Represents a response of an event payload
Field | Type |
|---|---|
id | UUID |
event_type | |
payload | None | str | Unset |
ReleaseCalendarEntryRequest
Request to release a scheduled workflow order. The parent and every child entry have their Release JSONB populated (with the current user id and the supplied Cellario.Cloud.Data.Api.Models.Calendar.ReleaseCalendarEntryRequest.Reason); the associated Commitment rows are deleted so the freed participant windows become available again. Released rows remain in the table for audit.
Attributes:
reason (None | str | Unset): Free-form reason recorded on the release record. Appears in audit /
history views. Null is allowed.Field | Type |
|---|---|
reason | None | str | Unset |
ReleaseRecord
Field | Type |
|---|---|
released_at | datetime.datetime |
released_by_user_id | UUID |
reason | None | str | Unset |
RescheduleCalendarEntryRequest
Request to move a previously-placed workflow order to a new start time. Semantically equivalent to releasing the current parent+children (reason: "Rescheduled") and re-running the schedule flow at Cellario.Cloud.Data.Api.Models.Calendar.RescheduleCalendarEntryRequest.PlannedStart. The released rows remain for audit.
Attributes:
planned_start (datetime.datetime): New wall-clock start time (T0) for the placement.
force_schedule (bool): When true, conflicts at the new time are accepted as warnings rather
than rejected.Field | Type |
|---|---|
planned_start | datetime.datetime |
force_schedule | bool |
ReservationSegmentRequest
Represents a time segment during which a resource is reserved within a protocol execution. Values are percentages (0-100) representing portions of the protocol's total duration. These values are inclusive but segments that touch at endpoints are considered non-overlapping.
Attributes:
start (int): Start of the reservation segment as a percentage of protocol duration (0-100)
end (int): End of the reservation segment as a percentage of protocol duration (0-100)Field | Type |
|---|---|
start | int |
end | int |
ReservationSegmentResponse
Represents a time segment during which a resource is reserved within a protocol execution. Values are percentages (0-100) representing portions of the protocol's total duration.
Attributes:
start (int): Start of the reservation segment as a percentage of protocol duration (0-100)
end (int): End of the reservation segment as a percentage of protocol duration (0-100)Field | Type |
|---|---|
start | int |
end | int |
ResourceConnectionParameterResponse
Connection parameter definition and configured value for a Direct resource.
Field | Type |
|---|---|
name | None | str |
optional | bool |
parameter_type | None | str | Unset |
default_value | None | str | Unset |
configured_value | None | str | Unset |
description | None | str | Unset |
min_value | float | None | Unset |
max_value | float | None | Unset |
unit | None | str | Unset |
valid_values | list[str] | None | Unset |
ResourceControlMode
Values
- DIRECT
- MANAGED
ResourceDataSetting
Values
- OFF
- ON
- SYSTEM
ResourceInclude
Values
- NONE
- OPERATIONS
ResourceInstructionResponse
Instruction Associated to the resource
Field | Type |
|---|---|
instruction_id | UUID |
operation | None | str | Unset |
name | None | str | Unset |
content | 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 |
ResourceInstructionUpdateRequest
Field | Type |
|---|---|
instruction_id | None | Unset | UUID |
operation | None | str | Unset |
ResourceMinimalResponse
Minimal details of a resource
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
parent_resource_id | None | Unset | UUID |
ResourceOperationPublishStatus
Values
- PUBLISHED
- REMOVED
- UNPUBLISHED
ResourcePositionResponse
Position in a resource AKA points, location
Attributes:
row (int | None | Unset): Row position in a resource
column (int | None | Unset): Column position in a resource
nest (int | None | Unset): Nest position in a resource
resource (None | ResourceMinimalResponse | Unset): Resource which the position belongs to
location (LocationMinimalResponse | None | Unset): Location where the resource residesField | Type |
|---|---|
row | int | None | Unset |
column | int | None | Unset |
nest | int | None | Unset |
resource | None | ResourceMinimalResponse | Unset |
location | LocationMinimalResponse | None | Unset |
ResourcePropertyResponse
Object for a free-form property
Field | Type |
|---|---|
name | None | str | Unset |
description | None | str | Unset |
value | None | str | Unset |
valid_values | None | ResourcePropertyResponseValidValuesType0 | Unset |
ResourcePropertyResponseValidValuesType0
Optional valid values for the property
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
ResourceReservationsResponse
Response model for protocol resource reservations and available resources
Field | Type |
|---|---|
protocol_id | UUID |
reservations | list[ProtocolResourceReservationResponse] | None | Unset |
available_resources | list[AvailableResourceResponse] | None | Unset |
ResourceResponse
Detailed information about a resource
Field | Type |
|---|---|
id | UUID |
name | str |
state | |
data_collection | |
location | |
control_mode | |
db_key | None | Unset | UUID |
parent_resource_id | None | Unset | UUID |
make | None | str | Unset |
model | None | str | Unset |
variant | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
is_simulated | bool | None | Unset |
is_enabled | bool | None | Unset |
is_data_collection_enabled | bool | None | Unset |
cart | CartMinimalResponse | None | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
child_resources | list[ResourceMinimalResponse] | None | Unset |
driver_package_name | None | str | Unset |
driver_version | None | str | Unset |
serial_number | None | str | Unset |
reporting_unit | None | Unset | VolumeUnit |
cellario_edge_id | None | Unset | UUID |
connection_parameters | list[ResourceConnectionParameterResponse] | None | Unset |
resource_properties | None | ResourceResponseResourcePropertiesType0 | Unset |
instructions | list[ResourceInstructionResponse] | None | Unset |
operations | list[OperationResponse] | 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 |
ResourceResponseResourcePropertiesType0
Resource properties from CellarioScheduler stored as key-value pairs
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
ResourceSort
Values
- CELLARIO_SYSTEM_NAME
- CELLARIO_SYSTEM_NAME_DESC
- MAKE
- MAKE_DESC
- MODEL
- MODEL_DESC
- NAME
- NAME_DESC
- STATE
- STATE_DESC
- VARIANT
- VARIANT_DESC
ResourceState
Values
- BUSY
- CONNECTED
- CONNECTING
- ERROR
- IDLE
- INITIALIZING
- NONE
- READY
- UNAVAILABLE
ResourceStateResponse
Information about the state of a resource
Field | Type |
|---|---|
id | UUID |
state | |
error_message | None | str | Unset |
claiming_workflow_order_id | None | Unset | UUID |
RetryPlateTransfersRequest
Retry a list of failed plate transfers with a new set of barcodes.
Field | Type |
|---|---|
plate_transfer_ids | list[UUID] |
barcodes | |
barcode_prefix | None | str | Unset |
RetryPlateTransfersRequestBarcodes
The replacement barcodes for the plate transfers being retried.
Field | Type |
|---|---|
additional_properties | dict[str, str] |
additional_keys | list[str] |
RightListItemResponse
A user right that is assigned to a user role to permit a user to perform specific actions on a resource
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
description | None | str | Unset |
alt_key | None | str | Unset |
category | None | str | Unset |
RightSort
Values
- CATEGORY
- CATEGORY_DESC
- DESCRIPTION
- DESCRIPTION_DESC
- NAME
- NAME_DESC
RoleRightBatchRequest
Request for batch adding rights to roles
Field | Type |
|---|---|
right_ids | list[UUID] | None | Unset |
RunOrderAction
Values
- COMPLETE
- PAUSE
- START
RunOrderControlRequest
Represents a request to control a run order.
Field | Type |
|---|---|
run_order_id | UUID |
action |
RunOrderMinimalResponse
Information about a run_order which is an object that tracks a cellario order
Field | Type |
|---|---|
id | UUID |
activity_id | UUID |
name | None | str | Unset |
description | None | str | Unset |
state | None | OrderStateResponse | Unset |
reference_id | int | None | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
date_actual_start | datetime.datetime | None | Unset |
date_actual_end | datetime.datetime | None | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
user_facing_id | None | str | Unset |
RunOrderParameterCreateRequest
Request to modify run order parameters in cloud and in the cellario order The parameter definition and default value must be created first as a protocol parameter
Attributes:
protocol_parameter_id (int): Corresponding protocol parameter id
order_sample_id (int | None | Unset): (Optional) unique Id of the order sample
parameter_value (None | str | Unset): Parameter valueField | Type |
|---|---|
protocol_parameter_id | int |
order_sample_id | int | None | Unset |
parameter_value | None | str | Unset |
RunOrderResponse
Information about a run_order which is an object that tracks a cellario order
Field | Type |
|---|---|
id | UUID |
activity_id | UUID |
state_id | UUID |
name | None | str | Unset |
description | None | str | Unset |
state | None | OrderStateResponse | Unset |
properties | list[ResourcePropertyResponse] | None | 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 |
reference_id | int | None | Unset |
date_requested_start | datetime.datetime | None | Unset |
date_scheduled_start | datetime.datetime | None | Unset |
date_scheduled_end | datetime.datetime | None | Unset |
date_actual_start | datetime.datetime | None | Unset |
date_actual_end | datetime.datetime | None | Unset |
cellario_system | CellarioSystemResponse | None | Unset |
order_instance | CellarioOrder | None | Unset |
well_transfer_instances | list[CellarioWellTransfer] | None | Unset |
files | list[FileReferenceResponse] | None | Unset |
SchedulerAction
Values
- PAUSE
- START
- STOP
SchedulerControlRequest
Represents a request to control the Cellario scheduler.
Field | Type |
|---|---|
action |
ScheduleWorkflowOrderRequest
Request to place a workflow order on the calendar at a specific start time. Triggers the plan builder to emit a WorkflowPlanTemplate, translates its step offsets against Cellario.Cloud.Data.Api.Models.Calendar.ScheduleWorkflowOrderRequest.PlannedStart, checks availability, and writes the parent/child CalendarEntry rows plus their Commitments in a single transaction.
Attributes:
workflow_order_id (UUID): Id of the workflow order to schedule.
planned_start (datetime.datetime): Wall-clock start time (T0) the workflow should be planned against.
force_schedule (bool): When true, conflicts detected during availability checking are accepted
as warnings (Schedule Anyway). When false (default), conflicts fail the
call with a 409 carrying the `CalendarConflictError` payload.Field | Type |
|---|---|
workflow_order_id | UUID |
planned_start | datetime.datetime |
force_schedule | bool |
SchedulingConstraintType
Values
- CONFIGURATION
- INVENTORY
- NONE
- TIMING
SchemaTypeEnum
Values
- ACTIVITIES
- LABWARE_TYPES
- SCIENTIFIC_PROTOCOLS
- WORKFLOWS
ScientificProtocolInclude
Values
- NONE
- PARAMETERS
- PORTS
ScientificProtocolListItemResponse
Detailed information about a scientific protocol
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
is_published | bool |
version | int |
is_cherry_pick | bool |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | 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 |
parameter_schema | None | ProtocolParameterSchemaResponse | Unset |
default_protocol | None | ProtocolListItemResponse | Unset |
protocols | list[ProtocolListItemResponse] | None | Unset |
cellario_systems | list[CellarioSystemMinimalResponse] | None | Unset |
ports | list[PortResponse] | None | Unset |
ScientificProtocolProtocolEligibleResponse
Represents if a protocol can be linked to a scientific protocol and if not now its inelegible
Field | Type |
|---|---|
protocol_list_item_response | None | ProtocolListItemResponse | Unset |
scientific_protocol_protocol_eligible_results | list[ScientificProtocolProtocolEligibleResult] | None | Unset |
ScientificProtocolProtocolEligibleResult
Values
- ALREADY_LINKED
- CHERRY_PICK_MISMATCH
- CHOICES_TYPE_MISMATCH
- ELIGIBLE
- INVALID_CHOICES
- INVALID_PROTOCOL
- PARAMETER_MISMATCH
- PORT_MISMATCH
- PORT_REQUIRED
ScientificProtocolResponse
Detailed information about a scientific protocol
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
version | int |
requires_transfer_list | bool |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
is_published | bool | None | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
files | list[FileReferenceResponse] | None | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | 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 |
properties | list[ResourcePropertyResponse] | None | Unset |
default_protocol | None | ProtocolListItemResponse | Unset |
protocols | list[ProtocolListItemResponse] | None | Unset |
cellario_systems | list[CellarioSystemMinimalResponse] | None | Unset |
ports | list[PortResponse] | None | Unset |
dilution_settings | DilutionSettings | None | Unset |
ScriptListItemResponse
Response model for listing scripts.
Field | Type |
|---|---|
name | str |
latest_version | str |
available_versions | list[str] |
is_archived | bool |
description | None | str | Unset |
last_modified_at | datetime.datetime | None | Unset |
last_modified_by_user_id | None | Unset | UUID |
ScriptPublishFilesBody
Field | Type |
|---|---|
name | str | Unset |
version_increment | str | Unset |
files | list[File] | Unset |
specific_version | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
ScriptPublishJsonBody
Field | Type |
|---|---|
name | str | Unset |
version_increment | str | Unset |
files | list[File] | Unset |
specific_version | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
ScriptQueueBodyRequest
Request body for enqueuing a script job (excludes script and version, which are provided via route).
Field | Type |
|---|---|
job_id | str |
inputs | str |
timeout | int |
workflow_order_id | UUID |
workflow_order_step_id | UUID |
token | None | str | Unset |
ScriptResponse
Response model for a script version.
Field | Type |
|---|---|
name | str |
version | str |
input_parameter_guids | list[str] |
output_parameter_guids | list[str] |
description | None | str | Unset |
SelectedParticipant
Field | Type |
|---|---|
id | UUID |
type_ |
SortKeyEnum
Values
- CREATED_DATA_TIME
- CREATED_DATA_TIME_DESCENDING
SplitBy
Values
- BARCODES
- COUNT
SplitByBarcodeRequest
Request to split a work order by a list of barcodes
Field | Type |
|---|---|
by | |
protocol_id | UUID |
barcodes | list[str] |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
SplitByPlateCountRequest
Request to split a work order by a given plate count
Field | Type |
|---|---|
by | |
protocol_id | UUID |
source_plate_count | int |
destination_plate_count | int |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
SplitEstimationResponse
Split order estimation details
Field | Type |
|---|---|
duration_seconds | int |
SplitRequest
Requests to split work orders into smaller units of work on a CellarioScheduler system
Field | Type |
|---|---|
by | |
protocol_id | UUID |
SplitResponse
Details of order created by a split work order request
Field | Type |
|---|---|
run_order_id | UUID |
scheduler_order_id | int | None | Unset |
StartWorkflowOperationRequest
Request DTO to start a workflow operation.
Field | Type |
|---|---|
run_order_id | int |
protocol_step_id | int |
sample_operation_id | int |
operation_type | |
scheduler_unique_operation_id | None | str | Unset |
operation_identifiers | list[str] | None | Unset |
operation_parameters | None | StartWorkflowOperationRequestOperationParametersType0 | Unset |
StartWorkflowOperationRequestOperationParametersType0
The parameter names and JSON value representations for the operation to start.
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
StartWorkflowOperationResponse
Response DTO from successfully starting a workflow operation.
Field | Type |
|---|---|
workflow_order_id | UUID |
workflow_order_step_id | UUID |
operation_id | None | str | Unset |
response | Any | Unset |
StepArgument
Field | Type |
|---|---|
variable_id | UUID |
name | None | str | Unset |
value | Any | Unset |
expression | None | str | Unset |
StepDescriptionResponse
Basic information about a step
Field | Type |
|---|---|
step_id | UUID |
activity_id | UUID |
activity_name | None | str | Unset |
ports | list[PortResponse] | None | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | Unset |
StepPlan
Field | Type |
|---|---|
source_id | UUID |
offset_from_start | str |
duration | |
participant_windows | list[ParticipantWindow] |
pool_claims | list[PoolClaim] |
SubscriberCreateRequest
Represents a request to create a subscriber to publish events to
Field | Type |
|---|---|
name | str |
subscription_type | |
state | |
web_hook_endpoint_url | None | str | Unset |
api_key | None | str | Unset |
SubscriberResponse
Represents a response of a created/modified subscriber
Field | Type |
|---|---|
id | UUID |
state | |
subscription_type | |
name | None | str | Unset |
web_hook_endpoint_url | None | str | Unset |
api_key | None | str | Unset |
SubscriberStateEnum
Values
- ACTIVE
- ARCHIVED
- DISABLED
- UNKNOWN
SubscriptionTypeEnum
Values
- UNKNOWN
- WEB_HOOK
- WEB_SOCKET
SyncJobCreateRequest
Represents a request to synchronize data
Field | Type |
|---|---|
job_type | |
force | bool |
SyncJobResponse
Represents a request to synchronize data across platform
Field | Type |
|---|---|
id | UUID |
job_type | |
status | |
percent_complete | float |
duration | int |
errors | list[str] | None | Unset |
date_created | datetime.datetime | None | Unset |
SyncJobType
Values
- AUTHORIZATION
- CELLARIO_EDGE_RESOURCE
- LABWARE
- PROTOCOL
- RESOURCE
- RUN_ORDER
- SYSTEM
SyncStatus
Values
- ACTIVE
- COMPLETED
- ERROR
- QUEUED
- SKIPPED
SystemAlertState
Values
- CELLARIO_ERROR
- DEVICE_ERROR
- NONE
SystemControlMode
Values
- AGENT
- EDGE
- UNKNOWN
SystemDataSetting
Values
- DISABLED
- OFF
- ON
SystemState
Values
- DELETING
- INITIALIZED
- INITIALIZING
- IN_ERROR
- NONE
- PAUSED
- PAUSING
- RUNNING
- STOPPED
- STOPPING
TaskParameterType
Values
- ARRAY
- BOOLEAN
- DICTIONARY
- FLOAT
- INT
- OBJECT
- STRING
TimeReservationInclude
Values
- CELLARIO_SYSTEMS
- NONE
- PARAMETERS
- RESOURCES
TimeReservationListItemResponse
List details about a time reservation
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
is_published | bool |
version | int |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | 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 |
parameter_schema | CustomSchemaResponse | None | Unset |
cellario_systems | list[CellarioSystemMinimalResponse] | None | Unset |
resources | list[ResourceMinimalResponse] | None | Unset |
TimeReservationResponse
Details about a time reservation
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
version | int |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
is_published | bool | None | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
files | list[FileReferenceResponse] | None | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | 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 |
properties | list[ResourcePropertyResponse] | None | Unset |
cellario_systems | list[CellarioSystemMinimalResponse] | None | Unset |
resources | list[ResourceMinimalResponse] | None | Unset |
participants | list[ParticipantResponse] | None | Unset |
TimeSeriesDataApiModel
Represents a measurement at a moment in time.
Field | Type |
|---|---|
time | datetime.datetime |
measurement_type | |
value | float |
inactive | float |
error | float |
active | float |
degraded | float |
degraded_depth | float |
resources_in_error | int |
TransferCreateRequest
Information about the transfer to be performed
Field | Type |
|---|---|
destination | |
volume | float |
solvent_type | str |
unit | |
source | None | TransferLocationRequest | Unset |
source_volume | float | None | Unset |
source_concentration | float | None | Unset |
target_concentration | float | None | Unset |
concentration_unit | ConcentrationUnit | None | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
TransferExportType
Values
- CALCULATED
- REQUESTED
TransferListExportRequest
Request model for exporting transfer list to CSV format
Field | Type |
|---|---|
transfer_type | |
plate_transfer_states | list[PlateTransferState] | None | Unset |
transfer_states | list[OperationState] | None | Unset |
plate_transfer_ids | list[UUID] | None | Unset |
barcodes | list[str] | None | Unset |
TransferLocationRequest
Detailed specifications of the transfer location
Field | Type |
|---|---|
column | int |
row | int |
TransferLocationResponse
Detailed specifications of the transfer location
Field | Type |
|---|---|
row | int |
column | int |
target_concentration | float | None | Unset |
target_volume | float | None | Unset |
TransferResponse
Information about the transfer to be performed
Field | Type |
|---|---|
destination | |
volume | float |
solvent_type | str |
unit | |
state | |
source | None | TransferLocationResponse | Unset |
error_message | None | str | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
transfer_type | None | TransferType | Unset |
source_concentration | float | None | Unset |
target_concentration | float | None | Unset |
concentration_unit | ConcentrationUnit | None | Unset |
tip | None | Unset | WellPosition |
TransferType
Values
- CALCULATED
- REQUESTED
UnlinkParametersFromTaskVersionRequest
Request model for unlinking (removing) specific parameters from a manual task version.
Field | Type |
|---|---|
input_parameter_ids | list[UUID] | None | Unset |
output_parameter_ids | list[UUID] | None | Unset |
UpdateActivityOperationRequest
The request model for updating an active operation
Field | Type |
|---|---|
order_id | int |
sample_operation_id | int |
action |
UpdateActivityParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
UpdateCartRequest
Update details on the cart
Field | Type |
|---|---|
name | str |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
UpdateDockRequest
Request model for updating a dock's name and location
Field | Type |
|---|---|
location_id | UUID |
name | None | str | Unset |
UpdateInstructionRequest
Fields to be changed for an existing instruction
Field | Type |
|---|---|
name | None | str | Unset |
content | None | str | Unset |
UpdateLabwareMappingCollectionRequest
Request to update a labware mapping collection
Field | Type |
|---|---|
name | None | str | Unset |
UpdateLabwareMappingRequest
Request to create a labware type mapping
Field | Type |
|---|---|
external_name | None | str | Unset |
labware_mapping_collection_id | None | Unset | UUID |
UpdateLocationRequest
Properties used to update a location
Field | Type |
|---|---|
location_type | |
parent_location_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
image_ref | None | str | Unset |
thumbnail_ref | None | str | Unset |
UpdateManualStepStateRequest
Request model for updating the state of a single step within a manual task instance.
Field | Type |
|---|---|
state | ManualStepState | None | Unset |
output_values | list[ParameterValueRequestModel] | None | Unset |
UpdateManualTaskDefinitionRequest
Request model for updating an EXISTING manual task v2. Can only update name OR a task definition of a draft task.
Field | Type |
|---|---|
name | None | str | Unset |
description | None | str | Unset |
task_definition | ManualTaskVersionDefinitionRequestModel | None | Unset |
UpdateMoveTaskRequest
Update a move task
Field | Type |
|---|---|
state | |
notes | None | str | Unset |
barcode | None | str | Unset |
UpdateOperationTaskRequest
Update a move task
Field | Type |
|---|---|
state | |
notes | None | str | Unset |
UpdateOrganizationRequest
Request object for updating an organizations information
Field | Type |
|---|---|
parent_id | None | Unset | UUID |
name | None | str | Unset |
description | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
organization_properties | list[ResourcePropertyResponse] | None | Unset |
UpdateParameterTypeDescriptorRequest
Request model for updating a parameter type descriptor. IsLibraryType is inherited from Cellario.Cloud.Data.Api.Models.Parameters.CreateParameterTypeDescriptorRequest as a nullable bool and follows PATCH-style "null leaves unchanged" semantics here.
Attributes:
name (str): The name of the parameter type descriptor
type_ (TaskParameterType):
read_only (bool): Indicates whether the parameter is read-only
required (bool): Indicates whether the parameter is required
display_hints (None | ParameterDisplayHintsRequest | Unset): The display hints for the parameter
sub_type_id (None | Unset | UUID): The ID of the sub-type, used if the root type is 'Array' or 'Dictionary'
(homogeneous element / value type). For 'Object', use
Cellario.Cloud.Data.Api.Models.Parameters.CreateParameterTypeDescriptorRequest.PropertyIds instead.
property_ids (list[UUID] | None | Unset): IDs of pre-existing descriptors to attach as named child properties
when
Cellario.Cloud.Data.Api.Models.Parameters.CreateParameterTypeDescriptorRequest.Type is 'Object'. Each referenced
descriptor must currently be unparented
(a top-level descriptor) — it becomes owned by this Object once linked. Position in
the list determines the property's order; the descriptor's own `Name` is used as
the property name within this Object. Required (non-empty) for 'Object'; must be
null or empty for any other type.
validation (None | ParameterValidationRequest | Unset): The validation rules for the parameter
default_value (None | str | Unset): The default value if none is provided. Stored as JSON string.
is_library_type (bool | None | Unset): Whether the parameter type descriptor is published as a reusable library
type
(visible in the type browser). Off by default; opt-in. Null is treated as false.
Nullable here to keep the JSON contract uniform with
Cellario.Cloud.Data.Api.Models.Parameters.UpdateParameterTypeDescriptorRequest, which uses PATCH-style
"null leaves unchanged" semantics. A derived class can't legally hide this with a
different nullability under System.Text.Json (it raises a JSON-name collision at
metadata-build time on .NET 8+).
library_type_id (None | Unset | UUID): When this descriptor was created by cloning a library-type descriptor,
the source library
type's ID. Null on ordinary descriptors and on library types themselves.
is_active (bool | None | Unset): Whether the parameter type descriptor is active (not deleted).
Null leaves the existing value unchanged.Field | Type |
|---|---|
name | str |
type_ | |
read_only | bool |
required | bool |
display_hints | None | ParameterDisplayHintsRequest | Unset |
sub_type_id | None | Unset | UUID |
property_ids | list[UUID] | None | Unset |
validation | None | ParameterValidationRequest | Unset |
default_value | None | str | Unset |
is_library_type | bool | None | Unset |
library_type_id | None | Unset | UUID |
is_active | bool | None | Unset |
UpdatePlateRequest
Information used to create a plate
Field | Type |
|---|---|
barcode | None | str | Unset |
labware_type_id | None | Unset | UUID |
location_id | None | Unset | UUID |
UpdateProtocolParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
UpdateProtocolPortRequest
Update a port
Field | Type |
|---|---|
type_ | |
name | None | str | Unset |
description | None | str | Unset |
id | None | Unset | UUID |
UpdateProtocolRequest
Information used to update a protocol in CellarioOS. NOTE: Most protocol fields are synced from CellarioScheduler and cannot be updated here. Only CellarioOS-managed fields are included in this request.
Attributes:
estimation_function (None | str | Unset): Mathematical expression for estimating protocol duration (null = use
default).
CellarioOS-only field not present in CellarioScheduler.
thumbnail_ref (None | str | Unset): A small image link to be used as a thumbnail.
UI display field not synced from CellarioScheduler.
image_ref (None | str | Unset): An image link that is displayed with this protocol.
UI display field not synced from CellarioScheduler.Field | Type |
|---|---|
estimation_function | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
UpdateResourceRequest
Form to provide updated information to a resource
Field | Type |
|---|---|
name | str |
location_id | UUID |
data_collection | |
make | None | str | Unset |
model | None | str | Unset |
variant | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
is_simulated | bool | None | Unset |
is_enabled | bool | None | Unset |
driver_package_name | None | str | Unset |
driver_version | None | str | Unset |
serial_number | None | str | Unset |
reporting_unit | None | Unset | VolumeUnit |
instructions | list[ResourceInstructionUpdateRequest] | None | Unset |
UpdateScientificProtocolProtocolRequest
Update a protocol already associated with a scientific protocol
Field | Type |
|---|---|
is_default | bool |
UpdateScientificProtocolRequest
Detailed information about a scientific protocol
Field | Type |
|---|---|
type_ | |
default_protocol_id | UUID |
organization_id | UUID |
name | str |
description | str |
version | int |
thumbnail_ref | str |
image_ref | str |
requires_transfer_list | bool |
properties | list[ResourcePropertyResponse] |
protocol_ids | list[UUID] | None | Unset |
ports | list[UpdateProtocolPortRequest] | None | Unset |
parameter_schema_id | None | Unset | UUID |
parameter_schema | None | Unset | UpdateProtocolParameterSchemaRequest |
dilution_settings | DilutionSettings | None | Unset |
UpdateTimeReservationRequest
Information used to update a time reservation activity
Field | Type |
|---|---|
organization_id | UUID |
name | str |
is_requestable | bool |
version | int |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
parameter_schema | None | Unset | UpdateActivityParameterSchemaRequest |
properties | list[ResourcePropertyResponse] | None | Unset |
cellario_system_ids | list[UUID] | None | Unset |
resource_ids | list[UUID] | None | Unset |
participants | list[SelectedParticipant] | None | Unset |
UpdateUserGroupRequest
Request to update an existing user group
Field | Type |
|---|---|
name | None | str | Unset |
description | None | str | Unset |
UpdateUserRequest
Request to update user details
Field | Type |
|---|---|
first_name | str |
last_name | str |
activate | bool |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
UpdateWorkflowParameterSchemaRequest
A custom schema for various objects which defines a set of custom strongly typed properties
Field | Type |
|---|---|
name | str |
schema_type | |
description | None | str | Unset |
parameters | list[CustomSchemaPropertyRequest] | None | Unset |
UpdateWorkflowRequest
Information for updating a workflow
Field | Type |
|---|---|
type_ | |
organization_id | UUID |
name | str |
steps | list[WorkflowStep] |
connections | list[WorkflowConnection] |
description | None | str | Unset |
image_ref | None | str | Unset |
thumbnail_ref | None | str | Unset |
parameter_schema_id | None | Unset | UUID |
parameter_schema | None | Unset | UpdateWorkflowParameterSchemaRequest |
UserDeleteEnum
Values
- INACTIVE
- LOCKED
UserGroupDetailResponse
Response containing user group details including members
Field | Type |
|---|---|
id | UUID |
name | str |
state | |
members | list[UserMinimalResponse] |
description | None | str | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
UserGroupResponse
Response containing user group details
Field | Type |
|---|---|
id | UUID |
name | str |
state | |
member_count | int |
description | None | str | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
UserGroupStateEnum
Values
- ACTIVE
- INACTIVE
UserListItemResponse
User Object to return when returning a list of users
Field | Type |
|---|---|
id | UUID |
state | |
organization_id | UUID |
first_name | None | str | Unset |
last_name | None | str | Unset |
short_name | None | str | Unset |
primary_email | None | str | Unset |
organization_name | None | str | Unset |
UserMinimalResponse
Full detailed user response
Field | Type |
|---|---|
id | UUID |
first_name | None | str | Unset |
last_name | None | str | Unset |
short_name | None | str | Unset |
primary_email | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
organization_name | None | str | Unset |
UserOrgRoles
An organization and roles for that organization that is assigned to a user
Field | Type |
|---|---|
org_id | str |
org_name | None | str | Unset |
user_roles | list[UserOrgRoleResponse] | None | Unset |
UserOrgRoleListItemResponse
Organizations and a role in that organization assigned to a user
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
role_id | UUID |
role_name | None | str | Unset |
organization_name | None | str | Unset |
UserOrgRoleResponse
Information about a specific role that can be granted by an organization
Field | Type |
|---|---|
id | UUID |
user_org_role_id | UUID |
name | None | str | Unset |
description | None | str | Unset |
UserResponse
Full detailed user response
Field | Type |
|---|---|
id | UUID |
state | |
organization_id | UUID |
external_profile_id | UUID |
first_name | None | str | Unset |
last_name | None | str | Unset |
short_name | None | str | Unset |
primary_email | None | str | Unset |
organization_name | None | str | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
rights | list[UserRightsListItemResponse] | None | Unset |
org_roles | list[UserOrgRoles] | None | Unset |
UserRightsListItemResponse
Information about user rights when presented in a list
Field | Type |
|---|---|
organization_id | UUID |
user_right_name | None | str | Unset |
user_right_key | None | str | Unset |
UserRoleResponse
Information about a user role that has been granted to the user by an orginization
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
name | None | str | Unset |
description | None | str | Unset |
UserStateEnum
Values
- ACTIVE
- INACTIVE
- LOCKED
V1ParameterMigrationResponse
Summary of a bulk workflow parameter migration run.
Field | Type |
|---|---|
total_versions | int |
migrated | int |
skipped | int |
failed | int |
errors | list[str] |
version_details | list[VersionMigrationDetail] | None | Unset |
V2WorkflowsCheckImportConflictsFilesBody
Field | Type |
|---|---|
file | File | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsCheckImportConflictsJsonBody
Field | Type |
|---|---|
file | File | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsCheckImportConflictsZipFilesBody
Field | Type |
|---|---|
file | File | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsCheckImportConflictsZipJsonBody
Field | Type |
|---|---|
file | File | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsImportFilesBody
Field | Type |
|---|---|
file | File |
conflicts_resolutions | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsImportJsonBody
Field | Type |
|---|---|
file | File |
conflicts_resolutions | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsImportZipFilesBody
Field | Type |
|---|---|
file | File |
conflicts_resolutions | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowsImportZipJsonBody
Field | Type |
|---|---|
file | File |
conflicts_resolutions | str | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowOrdersUploadFileFilesBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
V2WorkflowOrdersUploadFileJsonBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
ValidationConstraintResponse
Model to provide customer setting validation constraints.
Field | Type |
|---|---|
type_ | None | str | Unset |
parameters | None | Unset | ValidationConstraintResponseParametersType0 |
ValidationConstraintResponseParametersType0
Field | Type |
|---|---|
additional_properties | dict[str, Any] |
additional_keys | list[str] |
VersionBumpType
Values
- DRAFT
- MAJOR
- MINOR
- PATCH
VersionMigrationDetail
Per-version detail for a dry-run migration preview.
Field | Type |
|---|---|
version_id | UUID |
parameter_count | int |
is_legacy_v1_format | bool |
workflow_id | UUID |
version_number | str |
workflow_name | str |
VolumeUnit
Values
- L
- ML
- NL
- PL
- UL
- UNSPECIFIED
WellPosition
Shared well position (1-based row and column).
Field | Type |
|---|---|
row | int |
column | int |
WidgetType
Values
- BARCODE_INPUT
- CHECK
- DATE
- DATE_TIME
- DEFAULT
- FILE
- IMAGE
- NONE
- NUMERIC
- PASSWORD
- QR_CODE
- RADIO
- SECTION
- SELECT
- SLIDER
- SWITCH
- TABLE
- TEXT
- TEXT_AREA
- TIME
- URL
- VIDEO
WorkflowConnection
Information about how a two steps are connected
Field | Type |
|---|---|
source_step_id | UUID |
target_step_id | UUID |
source_port_id | None | Unset | UUID |
target_port_id | None | Unset | UUID |
WorkflowConnectionResponse
Information about how a two steps are connected
Field | Type |
|---|---|
source_step_id | UUID |
target_step_id | UUID |
source_port | None | PortResponse | Unset |
target_port | None | PortResponse | Unset |
WorkflowEngineControl
Field | Type |
|---|---|
enable_system_actions | bool |
enable_order_actions | bool |
WorkflowImportConflict
Field | Type |
|---|---|
is_archived | bool |
name | None | str | Unset |
id | None | Unset | UUID |
latest_version | None | str | Unset |
WorkflowImportConflictResponse
Field | Type |
|---|---|
workflow | None | Unset | WorkflowImportConflict |
guided_tasks | list[WorkflowImportConflict] | None | Unset |
scripts | list[WorkflowImportConflict] | None | Unset |
device_operations | list[WorkflowImportConflict] | None | Unset |
WorkflowListItemResponse
Minimal information about workflows
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
is_published | bool |
version | int |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | 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 |
parameter_schema | ActivityParameterSchemaResponse | None | Unset |
WorkflowMetadata
Field | Type |
|---|---|
created | datetime.datetime |
created_by | UUID |
updated | datetime.datetime |
updated_by | UUID |
version | None | str | Unset |
WorkflowMigrationResponse
Response for a bulk workflow migration run.
Field | Type |
|---|---|
to_version | float |
dry_run | bool |
v1_parameter_migration_result | None | Unset | V1ParameterMigrationResponse |
WorkflowOperationType
Values
- DEVICE_OPERATION
- GUIDED_TASK
- PROTOCOL
- REMOTE_SCRIPT
WorkflowOrder
Field | Type |
|---|---|
id | UUID |
workflow_id | UUID |
workflow_version | str |
name | str |
description | str |
arguments | list[WorkflowOrderArgument] |
parameters | list[WorkflowOrderParameter] |
user_facing_id | str |
state | |
scheduler_order_id | int |
metadata | None | Unset | WorkflowOrderMetadata |
cancellation_reason | None | str | Unset |
WorkflowOrderArgument
Field | Type |
|---|---|
workflow_parameter_id | UUID |
value | Any | Unset |
WorkflowOrderByAssetIdResponse
A workflow order's state keyed by its run-order asset id (CL-16371 orphaned-queue sweeper). Returned by POST /v1/workflow-orders/by-asset-ids. Asset ids with no matching workflow order are omitted from the response array.
Attributes:
asset_id (UUID): The run-order asset id (the prefix of the scheduler's `{assetId}:{operationId}` identifier).
state (WorkflowOrderState):Field | Type |
|---|---|
asset_id | UUID |
state |
WorkflowOrderByRuntimeIdResponse
A workflow order's state keyed by the manual-task runtime_id (CL-16680 orphaned-queue sweeper). The runtime id is the RabbitMQ queue name verbatim (the scheduler's scheduler_unique_operation_id). Returned by POST /v1/workflow-orders/by-runtime-ids. Runtime ids with no matching workflow order are omitted from the response array.
Attributes:
runtime_id (str): The manual-task runtime id (the RabbitMQ queue name == the operation's
scheduler_unique_operation_id).
state (WorkflowOrderState):Field | Type |
|---|---|
runtime_id | str |
state |
WorkflowOrderConnection
Field | Type |
|---|---|
id | UUID |
definitional_id | UUID |
source_step_id | UUID |
target_step_id | UUID |
created_at | datetime.datetime |
updated_at | datetime.datetime |
source_handle | None | str | Unset |
target_handle | None | str | Unset |
WorkflowOrderFileReferenceResponse
File reference response with workflow order context
Field | Type |
|---|---|
id | UUID |
type_ | |
sort_order | int |
status | |
source | |
date_created | datetime.datetime |
workflow_order_id | UUID |
description | None | str | Unset |
reference | None | str | Unset |
reference_id | None | Unset | UUID |
bucket_name | None | str | Unset |
name | None | str | Unset |
created_by_user | None | Unset | UserMinimalResponse |
workflow_order_step_id | None | Unset | UUID |
WorkflowOrderMetadata
Field | Type |
|---|---|
created_by_user_id | UUID |
created_at | datetime.datetime |
last_updated_by_user_id | UUID |
last_update | datetime.datetime |
assigned_to_user_id | UUID |
tags | list[str] |
cancel_requested_by_user_id | None | Unset | UUID |
cancel_requested_at | datetime.datetime | None | Unset |
WorkflowOrderParameter
Field | Type |
|---|---|
parameter_id | UUID |
parameter_type_descriptor_id | UUID |
name | str |
index | int |
description | None | str | Unset |
default_value | None | str | Unset |
WorkflowOrderResourcesResponse
Field | Type |
|---|---|
resources | list[ResourceStateResponse] | None | Unset |
WorkflowOrderSort
Values
- DATE_CREATED
- DATE_CREATED_DESC
- DATE_LAST_MODIFIED
- DATE_LAST_MODIFIED_DESC
- DESCRIPTION
- DESCRIPTION_DESC
- NAME
- NAME_DESC
- STATE
- STATE_DESC
- WORKFLOW_VERSION
- WORKFLOW_VERSION_DESC
WorkflowOrderState
Values
- CANCELLED
- CANCELLING
- COMPLETED
- IN_PROGRESS
- PENDING
- STARTING
WorkflowOrderStateResponse
Response for a workflow order state transition
Field | Type |
|---|---|
order_id | UUID |
previous_state | |
state |
WorkflowOrderStep
Field | Type |
|---|---|
id | UUID |
definitional_id | UUID |
index | int |
protocol_step_id | int |
position_x | float |
position_y | float |
state | |
created_at | datetime.datetime |
updated_at | datetime.datetime |
label | None | str | Unset |
hints | None | Unset | WorkflowOrderStepHintsType0 |
inputs | list[StepArgument] | None | Unset |
outputs | list[StepArgument] | None | Unset |
steps | list[WorkflowOrderStep] | None | Unset |
connections | list[WorkflowOrderConnection] | None | Unset |
WorkflowOrderStepsResponse
Response containing only the steps and connections for a workflow order. Use GET /workflow-orders/ to retrieve the full workflow order details.
Attributes:
steps (list[WorkflowOrderStep] | None | Unset):
connections (list[WorkflowOrderConnection] | None | Unset):Field | Type |
|---|---|
steps | list[WorkflowOrderStep] | None | Unset |
connections | list[WorkflowOrderConnection] | None | Unset |
WorkflowOrderStepHintsType0
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
WorkflowParameterCreateRequest
Request model for workflow parameters.
Field | Type |
|---|---|
parameter_type_descriptor_id | UUID |
description | str |
index | int |
parameter_id | None | Unset | UUID |
WorkflowParameterResponse
Response model for workflow parameters.
Field | Type |
|---|---|
id | UUID |
parameter_id | UUID |
parameter_type_descriptor | |
description | str |
index | int |
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 |
WorkflowPlanTemplate
Field | Type |
|---|---|
total_duration | |
step_plans | list[StepPlan] |
WorkflowResponse
Detailed information about the workflow entity
Field | Type |
|---|---|
id | UUID |
organization_id | UUID |
type_ | |
name | str |
is_requestable | bool |
version | int |
version_group_id | None | Unset | UUID |
description | None | str | Unset |
is_published | bool | None | Unset |
reference_id | int | None | Unset |
thumbnail_ref | None | str | Unset |
image_ref | None | str | Unset |
files | list[FileReferenceResponse] | None | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | 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 |
properties | list[ResourcePropertyResponse] | None | Unset |
steps | list[WorkflowStepResponse] | None | Unset |
connections | list[WorkflowConnectionResponse] | None | Unset |
WorkflowStep
Information about a given workflow step
Field | Type |
|---|---|
step_id | UUID |
activity_id | UUID |
description | None | str | Unset |
coordinate | Coordinate | None | Unset |
WorkflowStepResponse
Information about a given workflow step
Field | Type |
|---|---|
step_id | UUID |
activity_id | UUID |
activity_name | None | str | Unset |
description | None | str | Unset |
parameter_schema | ActivityParameterSchemaResponse | None | Unset |
ports | list[PortResponse] | None | Unset |
coordinate | Coordinate | None | Unset |
WorkflowStepState
Values
- CANCELED
- COMPLETED
- ERROR
- IN_PROGRESS
- PENDING
- SKIPPED
WorkflowStepV2
Field | Type |
|---|---|
id | UUID |
position_x | float |
position_y | float |
label | None | str | Unset |
hints | None | Unset | WorkflowStepV2HintsType0 |
inputs | list[StepArgument] | None | Unset |
outputs | list[StepArgument] | None | Unset |
steps | list[WorkflowStepV2] | None | Unset |
connections | list[Connection] | None | Unset |
estimated_duration | DurationSpecRecord | None | Unset |
max_iterations | int | None | Unset |
WorkflowStepV2HintsType0
Field | Type |
|---|---|
additional_properties | dict[str, None | str] |
additional_keys | list[str] |
WorkflowSummaryResponse
Field | Type |
|---|---|
id | UUID |
step_count | int |
last_modified | datetime.datetime |
last_modified_by | UUID |
name | None | str | Unset |
description | None | str | Unset |
version | None | str | Unset |
status | None | str | Unset |
WorkflowV2CreateRequest
Request model for creating a new workflow draft.
Field | Type |
|---|---|
name | str |
description | str |
parameters | |
steps | list[WorkflowStepV2] |
connections | list[Connection] |
id | None | Unset | UUID |
WorkflowV2Response
Response model for a workflow containing the full structure and configuration. Includes metadata, parameters, steps, and connections.
Attributes:
id (UUID): Gets or sets the unique identifier for the workflow.
name (str): Gets or sets the name of the workflow.
description (str): Gets or sets the description of the workflow.
parameters (list[WorkflowParameterResponse]): List of workflow parameters.
steps (list[WorkflowStepV2]): List of steps that define the workflow's execution logic.
connections (list[Connection]): List of connections between workflow steps.
metadata (None | Unset | WorkflowMetadata): Optional metadata providing additional information about the
workflow.Field | Type |
|---|---|
id | UUID |
name | str |
description | str |
parameters | list[WorkflowParameterResponse] |
steps | list[WorkflowStepV2] |
connections | list[Connection] |
metadata | None | Unset | WorkflowMetadata |
WorkflowVersionListItemResponse
One row of the workflow-versions listing: flat workflow and version metadata.
Field | Type |
|---|---|
version_id | UUID |
workflow_id | UUID |
workflow_name | str |
version | str |
version_type | str |
deleted | bool |
workflow_deleted | bool |
document_storage_id | UUID |
parameter_count | int |
step_count | int |
date_created | datetime.datetime |
WorkflowVersionResponse
Field | Type |
|---|---|
id | UUID |
workflow_id | UUID |
date_created | datetime.datetime |
step_count | int |
is_active | bool |
created_by_user_name | None | str | Unset |
version | None | str | Unset |
version_type | None | str | Unset |
WorkOrderAlertState
Values
- MISCONFIGURED_PARTICIPANTS
- NONE
WorkOrderCreateRequest
Information used to generate a new work order
Field | Type |
|---|---|
name | str |
activity_id | UUID |
requested_by_user_id | UUID |
description | None | str | Unset |
parameters | list[WorkOrderParameterCreateRequest] | None | Unset |
port_plates | list[PortPlateRequest] | None | Unset |
order_template_reference_id | int | None | Unset |
date_requested_start | datetime.datetime | None | Unset |
manual_duration_seconds | int | None | Unset |
secondary_protocol_id | None | Unset | UUID |
cellario_system_id | None | Unset | UUID |
correlation_id | None | str | Unset |
selected_participants | list[SelectedParticipant] | None | Unset |
dilution_settings | DilutionSettings | None | Unset |
WorkOrderEstimationResponse
Work order estimate details
Field | Type |
|---|---|
duration_seconds | int |
WorkOrderFilterOptionsResponse
Unique values to filter work order data by in the GET /work-orders endpoint
Field | Type |
|---|---|
created_by_users | list[UserMinimalResponse] | None | Unset |
modified_by_users | list[UserMinimalResponse] | None | Unset |
requested_by_users | list[UserMinimalResponse] | None | Unset |
cellario_system_names | list[str] | None | Unset |
order_states | list[OrderStateEnum] | None | Unset |
WorkOrderListFilterInclude
Values
- ACTIVITY
- CELLARIO_SYSTEM
- CHILD_RUN_ORDERS
- CREATED_BY_USER
- LAST_MODIFIED_BY_USER
- PARENT_WORK_ORDER
- REQUESTED_BY_USER
WorkOrderListItemResponse
Information returned about a work_order when in a list
Field | Type |
|---|---|
id | UUID |
user_facing_id | str |
activity_id | UUID |
state | |
alert_state | |
name | None | str | Unset |
description | None | str | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
is_work_available | bool | None | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
created_by_user | None | Unset | UserMinimalResponse |
last_modified_by_user | None | Unset | UserMinimalResponse |
reference_id | int | None | Unset |
requested_by_user | None | Unset | UserMinimalResponse |
date_requested_start | datetime.datetime | None | Unset |
reservation | None | Unset | WorkOrderReservationResponse |
runs | list[WorkOrderRunsListItemResponse] | None | Unset |
secondary_protocol_id | None | Unset | UUID |
cellario_system_name | None | str | Unset |
parent_work_order | None | Unset | WorkOrderMinimalResponse |
activity | ActivityResponse | None | Unset |
selected_participants | list[SelectedParticipant] | None | Unset |
misconfiguration_details | list[MisconfigurationDetail] | None | Unset |
WorkOrderMinimalResponse
Minimal work order response
Field | Type |
|---|---|
id | UUID |
user_facing_id | None | str | Unset |
WorkOrderParametersCreateRequest
Request to add work order parameters and/or plate parameters
Field | Type |
|---|---|
order_parameters | |
plates | list[PlateParametersRequest] |
WorkOrderParameterCreateRequest
Parameter for a work order which is not yet created
Field | Type |
|---|---|
activity_parameter_id | UUID |
value | Any | Unset |
WorkOrderParameterCreateRequestWithFile
Parameter for an existing work order that supports file parameter types
Field | Type |
|---|---|
activity_parameter_id | UUID |
value | Any | Unset |
file_reference_id | None | Unset | UUID |
WorkOrderParameterResponse
Parameter for a work order
Field | Type |
|---|---|
id | UUID |
activity_parameter | |
port_plate | None | PortPlateResponse | Unset |
barcode | None | str | Unset |
value | Any | Unset |
file_reference_id | None | Unset | UUID |
WorkOrderParameterUpdateRequest
Create or update a parameter for an existing work order
Field | Type |
|---|---|
activity_parameter_id | UUID |
port_plate_id | None | Unset | UUID |
value | Any | Unset |
file_reference_id | None | Unset | UUID |
WorkOrderRescheduleRequest
Information used when requesting a time reservation for a work_order
Field | Type |
|---|---|
date_reserved_start | datetime.datetime |
state | None | OrderStateEnum | Unset |
manual_duration_seconds | int | None | Unset |
WorkOrderRescheduleResponse
Information about a work_order reservation
Field | Type |
|---|---|
date_reserved_start | datetime.datetime |
date_reserved_end | datetime.datetime |
duration_seconds | int |
state | None | OrderStateEnum | Unset |
WorkOrderReservationRequest
Information used when requesting a time reservation for a work_order
Field | Type |
|---|---|
date_reserved_start | datetime.datetime |
manual_duration_seconds | int | None | Unset |
create_run | bool | None | Unset |
WorkOrderReservationResponse
Information about a work_order reservation
Field | Type |
|---|---|
date_reserved_start | datetime.datetime |
date_reserved_end | datetime.datetime |
duration_seconds | int |
WorkOrderResponse
Information about a work_order
Field | Type |
|---|---|
id | UUID |
name | str |
user_facing_id | str |
activity_id | UUID |
state | |
is_work_available | bool |
created_by_user | |
requested_by_user | |
alert_state | |
description | None | str | Unset |
cellario_system | CellarioSystemMinimalResponse | None | Unset |
properties | list[ResourcePropertyResponse] | None | Unset |
date_created | datetime.datetime | None | Unset |
date_last_modified | datetime.datetime | None | Unset |
last_modified_by_user | None | Unset | UserMinimalResponse |
reference_id | int | None | Unset |
date_requested_start | datetime.datetime | None | Unset |
reservation | None | Unset | WorkOrderReservationResponse |
runs | list[RunOrderResponse] | None | Unset |
files | list[FileReferenceResponse] | None | Unset |
parameters | list[WorkOrderParameterResponse] | None | Unset |
port_plates | list[PortPlateResponse] | None | Unset |
order_template_reference_id | int | None | Unset |
secondary_protocol_id | None | Unset | UUID |
comments | list[CommentResponse] | None | Unset |
correlation_id | None | str | Unset |
parent_work_order | None | Unset | WorkOrderMinimalResponse |
child_work_orders | list[WorkOrderMinimalResponse] | None | Unset |
selected_participants | list[ParticipantResponse] | None | Unset |
dilution_settings | DilutionSettings | None | Unset |
misconfiguration_details | list[MisconfigurationDetail] | None | Unset |
WorkOrderRunsListItemResponse
An object that describes a run in a work order
Field | Type |
|---|---|
id | UUID |
name | None | str | Unset |
date_actual_start | datetime.datetime | None | Unset |
date_actual_end | datetime.datetime | None | Unset |
WorkOrderRunCreateRequest
used to link a work_order and a run_order the work_order information is collected in the route
Field | Type |
|---|---|
run_order_id | UUID |
WorkOrderSort
Values
- ACTIVITY_NAME
- ACTIVITY_NAME_DESC
- ALERT_STATE
- ALERT_STATE_DESC
- CELLARIO_SYSTEM_NAME
- CELLARIO_SYSTEM_NAME_DESC
- CREATED_BY_USER_NAME
- CREATED_BY_USER_NAME_DESC
- DATE_CREATED
- DATE_CREATED_DESC
- DATE_LAST_MODIFIED
- DATE_LAST_MODIFIED_DESC
- IS_WORK_AVAILABLE
- IS_WORK_AVAILABLE_DESC
- LAST_MODIFIED_BY_USER_NAME
- LAST_MODIFIED_BY_USER_NAME_DESC
- NAME
- NAME_DESC
- PARENT_WORK_ORDER_USER_FACING_ID
- PARENT_WORK_ORDER_USER_FACING_ID_DESC
- REQUESTED_BY_USER_NAME
- REQUESTED_BY_USER_NAME_DESC
- RESERVATION_DURATION
- RESERVATION_DURATION_DESC
- RESERVATION_END_DATE
- RESERVATION_END_DATE_DESC
- RESERVATION_START_DATE
- RESERVATION_START_DATE_DESC
- STATE
- STATE_DESC
- USER_FACING_ID
- USER_FACING_ID_DESC
WorkOrderTransfersCreateRequest
Create or append new transfers to be performed for a work order
Field | Type |
|---|---|
transfers | list[PlateTransfersCreateRequest] |
dilution_settings | DilutionSettings | None | Unset |
WorkOrderUpdateRequest
Information used to generate a new work order
Field | Type |
|---|---|
name | str |
requested_by_user_id | UUID |
description | None | str | Unset |
parameters | list[WorkOrderParameterUpdateRequest] | None | Unset |
port_plates | list[PortPlateRequest] | None | Unset |
order_template_reference_id | int | None | Unset |
date_requested_start | datetime.datetime | None | Unset |
manual_duration_seconds | int | None | Unset |
secondary_protocol_id | None | Unset | UUID |
cellario_system_id | None | Unset | UUID |
selected_participants | list[SelectedParticipant] | None | Unset |
dilution_settings | DilutionSettings | None | Unset |
WorkOrderUploadFileFilesBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |
WorkOrderUploadFileJsonBody
Field | Type |
|---|---|
file | File |
type_ | |
description | str | Unset |
sort_order | int | Unset |
additional_properties | dict[str, Any] |
additional_keys | list[str] |