Data API — Manual Tasks Instance

16 min

manual_task_instance_by_id

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

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

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

manual_task_instance_cancel

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

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	CancelManualTaskRequest \| Unset	UNSET

body — Request model for canceling a manual task instance.

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

manual_task_instance_counts

sync(client: AuthenticatedClient | Client, created_from: datetime.datetime | Unset = UNSET, created_to: datetime.datetime | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, created_by_user_name: str | Unset = UNSET, assigned_to_user_id: UUID | Unset = UNSET, assigned_to_user_name: str | Unset = UNSET, involves_user_id: UUID | Unset = UNSET, updated_from: datetime.datetime | Unset = UNSET, updated_to: datetime.datetime | Unset = UNSET, name: str | Unset = UNSET, definition_id: UUID | Unset = UNSET, order_id: UUID | Unset = UNSET, order_reference_id: int | Unset = UNSET, runtime_id: str | Unset = UNSET, version: str | Unset = UNSET) -> ManualTaskInstanceCountsResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
created_from	datetime.datetime \| Unset	UNSET
created_to	datetime.datetime \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
created_by_user_name	str \| Unset	UNSET
assigned_to_user_id	UUID \| Unset	UNSET
assigned_to_user_name	str \| Unset	UNSET
involves_user_id	UUID \| Unset	UNSET
updated_from	datetime.datetime \| Unset	UNSET
updated_to	datetime.datetime \| Unset	UNSET
name	str \| Unset	UNSET
definition_id	UUID \| Unset	UNSET
order_id	UUID \| Unset	UNSET
order_reference_id	int \| Unset	UNSET
runtime_id	str \| Unset	UNSET
version	str \| Unset	UNSET

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

manual_task_instance_create

sync(id: UUID, version: str, operation_id: str, client: AuthenticatedClient | Client, body: InstantiateManualTaskRequest | Unset = UNSET) -> ManualTaskInstanceResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
version	str	required
operation_id	str	required
client	AuthenticatedClient \| Client	required
body	InstantiateManualTaskRequest \| Unset	UNSET

body — Request model for instantiating a manual task.

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

manual_task_instance_finish

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

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

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

manual_task_instance_list

sync(client: AuthenticatedClient | Client, created_from: datetime.datetime | Unset = UNSET, created_to: datetime.datetime | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, created_by_user_name: str | Unset = UNSET, assigned_to_user_id: UUID | Unset = UNSET, assigned_to_user_name: str | Unset = UNSET, involves_user_id: UUID | Unset = UNSET, updated_from: datetime.datetime | Unset = UNSET, updated_to: datetime.datetime | Unset = UNSET, states: list[ManualTaskState] | Unset = UNSET, name: str | Unset = UNSET, definition_id: UUID | Unset = UNSET, order_id: UUID | Unset = UNSET, order_reference_id: int | Unset = UNSET, runtime_id: str | Unset = UNSET, version: str | Unset = UNSET, sort: list[ManualTaskInstanceSort] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ManualTaskInstanceListResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
created_from	datetime.datetime \| Unset	UNSET
created_to	datetime.datetime \| Unset	UNSET
created_by_user_id	UUID \| Unset	UNSET
created_by_user_name	str \| Unset	UNSET
assigned_to_user_id	UUID \| Unset	UNSET
assigned_to_user_name	str \| Unset	UNSET
involves_user_id	UUID \| Unset	UNSET
updated_from	datetime.datetime \| Unset	UNSET
updated_to	datetime.datetime \| Unset	UNSET
states	list[ManualTaskState] \| Unset	UNSET
name	str \| Unset	UNSET
definition_id	UUID \| Unset	UNSET
order_id	UUID \| Unset	UNSET
order_reference_id	int \| Unset	UNSET
runtime_id	str \| Unset	UNSET
version	str \| Unset	UNSET
sort	list[ManualTaskInstanceSort] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

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

manual_task_instance_start

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

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

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

manual_task_instance_update_step_state

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

Parameter	Type	Default
id	UUID	required
step_id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateManualStepStateRequest \| Unset	UNSET

body — Request model for updating the state of a single step within a manual task instance.

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