Data API — Work Order Runs

12 min

work_order_run_create

sync(work_order_id: UUID, client: AuthenticatedClient | Client, body: WorkOrderRunCreateRequest | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[RunOrderResponse] | None

Parameter	Type	Default
work_order_id	UUID	required
client	AuthenticatedClient \| Client	required
body	WorkOrderRunCreateRequest \| Unset	UNSET

body — used to link a work_order and a run_order the work_order information is collected in the route

Returns: ProblemDetails | list[ErrorResponse] | list[RunOrderResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

work_order_run_delete

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

Parameter	Type	Default
work_order_id	UUID	required
run_order_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

work_order_run_list

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

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

Returns: ProblemDetails | list[ErrorResponse] | list[RunOrderResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

work_order_run_parameters_add

sync(work_order_id: UUID, run_order_id: UUID, client: AuthenticatedClient | Client, body: list[RunOrderParameterCreateRequest] | Unset = UNSET) -> ProblemDetails | list[CellarioRunOrderParameter] | list[ErrorResponse] | None

Parameter	Type	Default
work_order_id	UUID	required
run_order_id	UUID	required
client	AuthenticatedClient \| Client	required
body	list[RunOrderParameterCreateRequest] \| Unset	UNSET

Returns: ProblemDetails | list[CellarioRunOrderParameter] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

work_order_run_parameters_delete

sync(work_order_id: UUID, run_order_id: UUID, parameter_id: int, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
work_order_id	UUID	required
run_order_id	UUID	required
parameter_id	int	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

work_order_run_parameters_list

sync(work_order_id: UUID, run_order_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | list[CellarioRunOrderParameter] | list[ErrorResponse] | None

Parameter	Type	Default
work_order_id	UUID	required
run_order_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | list[CellarioRunOrderParameter] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.