Data API — Work Orders
bulk_associated_plates_transfer_transition_state
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: BulkPlateTransfersStateUpdateRequest | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | BulkPlateTransfersStateUpdateRequest | Unset | UNSET |
- body — Bulk state update of plate transfers request
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
estimate_work_order_duration
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: str | Unset = UNSET, override_protocol_id: UUID | Unset = UNSET) -> ProblemDetails | ProtocolEstimationResultResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | str | Unset | UNSET |
override_protocol_id | UUID | Unset | UNSET |
Returns: ProblemDetails | ProtocolEstimationResultResponse | 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. |
get_work_order_plate_relations
sync(work_order_id: UUID, client: AuthenticatedClient | Client, transfer_state: list[PlateRelationTransferState] | Unset = UNSET, include: list[PlateRelationsInclude] | Unset = UNSET) -> PlateRelationsResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
transfer_state | list[PlateRelationTransferState] | Unset | UNSET |
include | list[PlateRelationsInclude] | Unset | UNSET |
Returns: PlateRelationsResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_add_parameters
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderParametersCreateRequest | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkOrderParameterResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | WorkOrderParametersCreateRequest | Unset | UNSET |
- body — Request to add work order parameters and/or plate parameters
Returns: ProblemDetails | list[ErrorResponse] | list[WorkOrderParameterResponse] | 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. |
work_order_add_transfers
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderTransfersCreateRequest | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | WorkOrderTransfersCreateRequest | Unset | UNSET |
- body — Create or append new transfers to be performed for a work order
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_comment_list
sync(work_order_id: UUID, client: AuthenticatedClient | Client, sort_key: SortKeyEnum | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[OrderCommentResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
sort_key | SortKeyEnum | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[OrderCommentResponse] | 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. |
work_order_create
sync(client: AuthenticatedClient | Client, body: WorkOrderCreateRequest | Unset = UNSET) -> ProblemDetails | WorkOrderResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | WorkOrderCreateRequest | Unset | UNSET |
- body — Information used to generate a new work order
Returns: ProblemDetails | WorkOrderResponse | 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. |
work_order_create_comment
sync(work_order_id: UUID, client: AuthenticatedClient | Client, comment: str | Unset = UNSET) -> OrderCommentResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
comment | str | Unset | UNSET |
Returns: OrderCommentResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_delete
sync(work_order_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_delete_file
sync(work_order_id: UUID, reference_id: UUID, client: AuthenticatedClient | Client, remove_from_parameters: bool | Unset = False) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
reference_id | UUID | required |
client | AuthenticatedClient | Client | required |
remove_from_parameters | bool | Unset | False |
- remove_from_parameters — Default: False.
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_describe
sync(work_order_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkOrderResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkOrderResponse | 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. |
work_order_estimation
sync(work_order_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkOrderEstimationResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkOrderEstimationResponse | 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. |
work_order_export_transfers
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: TransferListExportRequest | Unset = UNSET) -> File | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | TransferListExportRequest | Unset | UNSET |
- body — Request model for exporting transfer list to CSV format
Returns: File | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_filters
sync(client: AuthenticatedClient | Client) -> ProblemDetails | WorkOrderFilterOptionsResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkOrderFilterOptionsResponse | 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. |
work_order_list
sync(client: AuthenticatedClient | Client, requested_by_user_id: list[UUID] | Unset = UNSET, location_id: UUID | Unset = UNSET, cellario_system_name: list[str] | Unset = UNSET, secondary_protocol_id: UUID | Unset = UNSET, sort: list[WorkOrderSort] | Unset = UNSET, parent_work_order_user_facing_id: str | Unset = UNSET, reservation_start_from: datetime.datetime | Unset = UNSET, reservation_start_to: datetime.datetime | Unset = UNSET, reservation_end_from: datetime.datetime | Unset = UNSET, reservation_end_to: datetime.datetime | Unset = UNSET, assigned_to_user_id: list[UUID] | Unset = UNSET, is_work_available: bool | Unset = UNSET, participant_search: list[str] | Unset = UNSET, alert_states: list[WorkOrderAlertState] | Unset = UNSET, misconfiguration_reasons: list[MisconfigurationReason] | Unset = UNSET, misconfigured_participant_ids: list[UUID] | Unset = UNSET, include: list[WorkOrderListFilterInclude] | Unset = UNSET, name: str | Unset = UNSET, activity_name: str | Unset = UNSET, activity_id: UUID | Unset = UNSET, cellario_system_id: UUID | Unset = UNSET, user_facing_id: str | Unset = UNSET, states: list[OrderStateEnum] | Unset = UNSET, date_created: datetime.datetime | Unset = UNSET, date_last_modified: datetime.datetime | Unset = UNSET, created_by_user_id: list[UUID] | Unset = UNSET, last_modified_by_user_id: list[UUID] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET, reference_id: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkOrderListItemResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
requested_by_user_id | list[UUID] | Unset | UNSET |
location_id | UUID | Unset | UNSET |
cellario_system_name | list[str] | Unset | UNSET |
secondary_protocol_id | UUID | Unset | UNSET |
sort | list[WorkOrderSort] | Unset | UNSET |
parent_work_order_user_facing_id | str | Unset | UNSET |
reservation_start_from | datetime.datetime | Unset | UNSET |
reservation_start_to | datetime.datetime | Unset | UNSET |
reservation_end_from | datetime.datetime | Unset | UNSET |
reservation_end_to | datetime.datetime | Unset | UNSET |
assigned_to_user_id | list[UUID] | Unset | UNSET |
is_work_available | bool | Unset | UNSET |
participant_search | list[str] | Unset | UNSET |
alert_states | list[WorkOrderAlertState] | Unset | UNSET |
misconfiguration_reasons | list[MisconfigurationReason] | Unset | UNSET |
misconfigured_participant_ids | list[UUID] | Unset | UNSET |
include | list[WorkOrderListFilterInclude] | Unset | UNSET |
name | str | Unset | UNSET |
activity_name | str | Unset | UNSET |
activity_id | UUID | Unset | UNSET |
cellario_system_id | UUID | Unset | UNSET |
user_facing_id | str | Unset | UNSET |
states | list[OrderStateEnum] | Unset | UNSET |
date_created | datetime.datetime | Unset | UNSET |
date_last_modified | datetime.datetime | Unset | UNSET |
created_by_user_id | list[UUID] | Unset | UNSET |
last_modified_by_user_id | list[UUID] | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
reference_id | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[WorkOrderListItemResponse] | 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. |
work_order_list_transfers
sync(work_order_id: UUID, client: AuthenticatedClient | Client, barcodes: list[str] | Unset = UNSET, include: list[PlateTransfersInclude] | Unset = UNSET, connected_to_plate_transfer_ids: list[UUID] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[PlateTransfersResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
barcodes | list[str] | Unset | UNSET |
include | list[PlateTransfersInclude] | Unset | UNSET |
connected_to_plate_transfer_ids | list[UUID] | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[PlateTransfersResponse] | 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. |
work_order_process_transfer_list
sync(work_order_id: UUID, reference_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkOrderResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
reference_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkOrderResponse | 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. |
work_order_process_transfer_lists
sync(work_order_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkOrderResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkOrderResponse | 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. |
work_order_reschedule_state
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderRescheduleRequest | Unset = UNSET) -> ProblemDetails | WorkOrderRescheduleResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | WorkOrderRescheduleRequest | Unset | UNSET |
- body — Information used when requesting a time reservation for a work_order
Returns: ProblemDetails | WorkOrderRescheduleResponse | 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. |
work_order_reservation
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderReservationRequest | Unset = UNSET) -> ProblemDetails | WorkOrderReservationResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | WorkOrderReservationRequest | Unset | UNSET |
- body — Information used when requesting a time reservation for a work_order
Returns: ProblemDetails | WorkOrderReservationResponse | 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. |
work_order_retry_plate_transfers
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: RetryPlateTransfersRequest | Unset = UNSET) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | RetryPlateTransfersRequest | Unset | UNSET |
- body — Retry a list of failed plate transfers with a new set of barcodes.
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_search_transfers
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: PlateTransfersFilterApiModel | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[PlateTransfersResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | PlateTransfersFilterApiModel | Unset | UNSET |
- body — Filter model for Get transfers
Returns: ProblemDetails | list[ErrorResponse] | list[PlateTransfersResponse] | 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. |
work_order_transition_state
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: OrderUpdateStateRequest | Unset = UNSET) -> OrderTransitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | OrderUpdateStateRequest | Unset | UNSET |
- body — Request to update the state of an order
Returns: OrderTransitionResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_update
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderUpdateRequest | Unset = UNSET) -> ProblemDetails | WorkOrderResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | WorkOrderUpdateRequest | Unset | UNSET |
- body — Information used to generate a new work order
Returns: ProblemDetails | WorkOrderResponse | 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. |
work_order_update_file
sync(work_order_id: UUID, reference_id: UUID, client: AuthenticatedClient | Client, body: FileUpdateRequest | Unset = UNSET) -> FileReferenceResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
reference_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | FileUpdateRequest | Unset | UNSET |
- body — Update an existing file reference
Returns: FileReferenceResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_upload_file
sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderUploadFileFilesBody | WorkOrderUploadFileJsonBody | Unset = UNSET) -> FileReferenceResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | WorkOrderUploadFileFilesBody | WorkOrderUploadFileJsonBody | Unset | UNSET |
Returns: FileReferenceResponse | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |
work_order_valid_runs
sync(work_order_id: UUID, client: AuthenticatedClient | Client, include_already_linked: bool | Unset = UNSET, from_: datetime.datetime | Unset = UNSET, to: datetime.datetime | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[RunOrderMinimalResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
include_already_linked | bool | Unset | UNSET |
from_ | datetime.datetime | Unset | UNSET |
to | datetime.datetime | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[RunOrderMinimalResponse] | 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. |
work_order_valid_states
sync(work_order_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
work_order_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | list[ErrorResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |