Data API — Events
error_events_list
sync(client: AuthenticatedClient | Client, source: str | Unset = UNSET, source_type: EventSourceType | Unset = UNSET, type_: EventType | Unset = UNSET, from_: datetime.datetime | Unset = UNSET, to: datetime.datetime | Unset = UNSET, resource_id: UUID | Unset = UNSET, system_id: UUID | Unset = UNSET, system_name: str | Unset = UNSET, location_id: UUID | Unset = UNSET, top: int | Unset = 5, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorEventResponse] | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
source | str | Unset | UNSET |
source_type | EventSourceType | Unset | UNSET |
type_ | EventType | Unset | UNSET |
from_ | datetime.datetime | Unset | UNSET |
to | datetime.datetime | Unset | UNSET |
resource_id | UUID | Unset | UNSET |
system_id | UUID | Unset | UNSET |
system_name | str | Unset | UNSET |
location_id | UUID | Unset | UNSET |
top | int | Unset | 5 |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
- top — Default: 5.
Returns: ProblemDetails | list[ErrorEventResponse] | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
events_list
sync(client: AuthenticatedClient | Client, source: str | Unset = UNSET, description: str | Unset = UNSET, source_type: list[EventSourceType] | Unset = UNSET, type_: list[EventType] | Unset = UNSET, states: list[EventState] | Unset = UNSET, from_: datetime.datetime | Unset = UNSET, to: datetime.datetime | Unset = UNSET, reference_id: int | Unset = UNSET, metadata: list[str] | Unset = UNSET, parameters: list[str] | Unset = UNSET, sort: list[EventSort] | Unset = UNSET, include_types: list[EventFilterIncludeType] | Unset = UNSET, resource_id: UUID | Unset = UNSET, plate_id: UUID | Unset = UNSET, plate_reference_id: int | Unset = UNSET, protocol_id: UUID | Unset = UNSET, protocol_reference_id: int | Unset = UNSET, operation_id: UUID | Unset = UNSET, operation_reference_id: int | Unset = UNSET, run_order_id: UUID | Unset = UNSET, order_reference_id: int | Unset = UNSET, work_order_id: UUID | Unset = UNSET, system_id: UUID | Unset = UNSET, system_name: str | Unset = UNSET, plate_protocol_reference_id: int | Unset = UNSET, sample_operation_reference_id: int | Unset = UNSET, order_sample_reference_id: int | Unset = UNSET, labware_type_id: UUID | Unset = UNSET, protocol_step_reference_id: int | Unset = UNSET, destination_resource_id: UUID | Unset = UNSET, operation_resource_id: UUID | Unset = UNSET, system_location_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET, correlation_id: UUID | Unset = UNSET, resource_reference_id: UUID | Unset = UNSET, cellario_edge_reference_id: UUID | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[EventResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
source | str | Unset | UNSET |
description | str | Unset | UNSET |
source_type | list[EventSourceType] | Unset | UNSET |
type_ | list[EventType] | Unset | UNSET |
states | list[EventState] | Unset | UNSET |
from_ | datetime.datetime | Unset | UNSET |
to | datetime.datetime | Unset | UNSET |
reference_id | int | Unset | UNSET |
metadata | list[str] | Unset | UNSET |
parameters | list[str] | Unset | UNSET |
sort | list[EventSort] | Unset | UNSET |
include_types | list[EventFilterIncludeType] | Unset | UNSET |
resource_id | UUID | Unset | UNSET |
plate_id | UUID | Unset | UNSET |
plate_reference_id | int | Unset | UNSET |
protocol_id | UUID | Unset | UNSET |
protocol_reference_id | int | Unset | UNSET |
operation_id | UUID | Unset | UNSET |
operation_reference_id | int | Unset | UNSET |
run_order_id | UUID | Unset | UNSET |
order_reference_id | int | Unset | UNSET |
work_order_id | UUID | Unset | UNSET |
system_id | UUID | Unset | UNSET |
system_name | str | Unset | UNSET |
plate_protocol_reference_id | int | Unset | UNSET |
sample_operation_reference_id | int | Unset | UNSET |
order_sample_reference_id | int | Unset | UNSET |
labware_type_id | UUID | Unset | UNSET |
protocol_step_reference_id | int | Unset | UNSET |
destination_resource_id | UUID | Unset | UNSET |
operation_resource_id | UUID | Unset | UNSET |
system_location_id | UUID | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
correlation_id | UUID | Unset | UNSET |
resource_reference_id | UUID | Unset | UNSET |
cellario_edge_reference_id | UUID | Unset | UNSET |
- metadata — Example: ['SystemName:cella'].
- parameters — Example: ['Name:Block Height'].
Returns: ProblemDetails | list[ErrorResponse] | list[EventResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |