Data API — v2 Workflow Engine

8 min

v2_workflow_engine_get_control

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

Parameter	Type	Default
client	AuthenticatedClient \| Client	required

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

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

Parameter	Type	Default
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.

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

Parameter	Type	Default
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.

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

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

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.