Data API — v2 Workflow Orders

38 min

v2_workflow_orders_accept_step

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

Parameter	Type	Default
order_id	UUID	required
order_step_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: 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.

v2_workflow_orders_create

sync(client: AuthenticatedClient | Client, body: CreateWorkflowOrderRequest | Unset = UNSET) -> ProblemDetails | WorkflowOrder | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateWorkflowOrderRequest \| Unset	UNSET

Returns: ProblemDetails | WorkflowOrder | 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.

v2_workflow_orders_delete

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

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

Returns: 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.

v2_workflow_orders_delete_file

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

Parameter	Type	Default
order_id	UUID	required
file_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.

v2_workflow_orders_delete_if_pending

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

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

Returns: 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.

v2_workflow_orders_get

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

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

Returns: ProblemDetails | WorkflowOrder | 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.

v2_workflow_orders_get_resources

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

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

Returns: ProblemDetails | WorkflowOrderResourcesResponse | 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.

v2_workflow_orders_get_step

sync(order_id: UUID, order_step_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkflowOrderStep | list[ErrorResponse] | None

Parameter	Type	Default
order_id	UUID	required
order_step_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | WorkflowOrderStep | 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.

v2_workflow_orders_get_steps

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

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

Returns: ProblemDetails | WorkflowOrderStepsResponse | 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.

v2_workflow_orders_list

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET, sort: list[WorkflowOrderSort] | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowOrder] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET
sort	list[WorkflowOrderSort] \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowOrder] | 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.

v2_workflow_orders_list_files

sync(order_id: UUID, client: AuthenticatedClient | Client, step_id: UUID | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowOrderFileReferenceResponse] | None

Parameter	Type	Default
order_id	UUID	required
client	AuthenticatedClient \| Client	required
step_id	UUID \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowOrderFileReferenceResponse] | 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.

v2_workflow_orders_request_cancel

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

Parameter	Type	Default
order_id	UUID	required
client	AuthenticatedClient \| Client	required
body	CancelWorkflowOrderRequest \| Unset	UNSET

body — Request DTO for cancelling a workflow order.

Returns: 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.

v2_workflow_orders_request_start

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

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

Returns: ProblemDetails | WorkflowOrderStateResponse | 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.

v2_workflow_orders_retry_step

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

Parameter	Type	Default
order_id	UUID	required
order_step_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: 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.

v2_workflow_orders_states_by_asset_ids

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

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

Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowOrderByAssetIdResponse] | 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.

v2_workflow_orders_states_by_runtime_ids

sync(client: AuthenticatedClient | Client, body: list[str] | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowOrderByRuntimeIdResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	list[str] \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowOrderByRuntimeIdResponse] | 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.

v2_workflow_orders_update

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

Parameter	Type	Default
order_id	UUID	required
client	AuthenticatedClient \| Client	required
body	WorkflowOrder \| Unset	UNSET

Returns: ProblemDetails | WorkflowOrder | 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.

v2_workflow_orders_update_file

sync(order_id: UUID, file_id: UUID, client: AuthenticatedClient | Client, body: FileUpdateRequest | Unset = UNSET) -> ProblemDetails | WorkflowOrderFileReferenceResponse | list[ErrorResponse] | None

Parameter	Type	Default
order_id	UUID	required
file_id	UUID	required
client	AuthenticatedClient \| Client	required
body	FileUpdateRequest \| Unset	UNSET

body — Update an existing file reference

Returns: ProblemDetails | WorkflowOrderFileReferenceResponse | 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.

v2_workflow_orders_upload_file

sync(order_id: UUID, client: AuthenticatedClient | Client, body: V2WorkflowOrdersUploadFileFilesBody | V2WorkflowOrdersUploadFileJsonBody | Unset = UNSET, step_id: UUID | Unset = UNSET, parameter_id: UUID | Unset = UNSET) -> ProblemDetails | WorkflowOrderFileReferenceResponse | list[ErrorResponse] | None

Parameter	Type	Default
order_id	UUID	required
client	AuthenticatedClient \| Client	required
body	V2WorkflowOrdersUploadFileFilesBody \| V2WorkflowOrdersUploadFileJsonBody \| Unset	UNSET
step_id	UUID \| Unset	UNSET
parameter_id	UUID \| Unset	UNSET

Returns: ProblemDetails | WorkflowOrderFileReferenceResponse | 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.