Data API — Manual Tasks Definition
link_parameters_to_task_version
sync(id: UUID, version: str, client: AuthenticatedClient | Client, body: LinkParametersToTaskVersionRequest | Unset = UNSET) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
body | LinkParametersToTaskVersionRequest | Unset | UNSET |
- body — Request model for linking parameters to a manual task version. Replaces all existing parameters with the provided lists.
Returns: ManualTaskDefinitionResponse | 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. |
manual_task_archive
sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
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. |
manual_task_by_id
sync(id: UUID, client: AuthenticatedClient | Client) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ManualTaskDefinitionResponse | 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. |
manual_task_create
sync(client: AuthenticatedClient | Client, body: CreateManualTaskDefinitionRequest | Unset = UNSET) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | CreateManualTaskDefinitionRequest | Unset | UNSET |
- body — Request model for creating a NEW manual task v2. E.g. from File >> New >> Manual Task
Returns: ManualTaskDefinitionResponse | 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. |
manual_task_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, updated_from: datetime.datetime | Unset = UNSET, updated_to: datetime.datetime | Unset = UNSET, name: str | Unset = UNSET, status: list[ManualTaskDefinitionStatus] | Unset = UNSET, sort: list[ManualTaskDefinitionSort] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[ManualTaskDefinitionListResponse] | NoneParameter | 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 |
updated_from | datetime.datetime | Unset | UNSET |
updated_to | datetime.datetime | Unset | UNSET |
name | str | Unset | UNSET |
status | list[ManualTaskDefinitionStatus] | Unset | UNSET |
sort | list[ManualTaskDefinitionSort] | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[ManualTaskDefinitionListResponse] | 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. |
manual_task_step_delete_file
sync(id: UUID, version: str, step_id: UUID, file_reference_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
step_id | UUID | required |
file_reference_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. |
manual_task_step_upload_file
sync(id: UUID, version: str, step_id: UUID, client: AuthenticatedClient | Client, body: ManualTaskStepUploadFileFilesBody | ManualTaskStepUploadFileJsonBody | Unset = UNSET) -> FileReferenceResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
step_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | ManualTaskStepUploadFileFilesBody | ManualTaskStepUploadFileJsonBody | 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. |
manual_task_unarchive
sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
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. |
manual_task_update_draft
sync(id: UUID, version: str, client: AuthenticatedClient | Client, body: UpdateManualTaskDefinitionRequest | Unset = UNSET) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
body | UpdateManualTaskDefinitionRequest | Unset | UNSET |
- body — Request model for updating an EXISTING manual task v2. Can only update name OR a task definition of a draft task.
Returns: ManualTaskDefinitionResponse | 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. |
manual_task_versions
sync(id: UUID, client: AuthenticatedClient | Client) -> ManualTaskVersionsListResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ManualTaskVersionsListResponse | 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. |
manual_task_version_by_id
sync(id: UUID, version: str, client: AuthenticatedClient | Client) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
Returns: ManualTaskDefinitionResponse | 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. |
manual_task_version_create
sync(id: UUID, client: AuthenticatedClient | Client, version_bump: VersionBumpType | Unset = UNSET) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
client | AuthenticatedClient | Client | required |
version_bump | VersionBumpType | Unset | UNSET |
Returns: ManualTaskDefinitionResponse | 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. |
manual_task_version_delete
sync(id: UUID, version: str, client: AuthenticatedClient | Client) -> Any | ProblemDetails | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
Returns: Any | ProblemDetails | 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. |
manual_task_version_parameters
sync(id: UUID, version: str, client: AuthenticatedClient | Client) -> ManualTaskVersionParametersResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
Returns: ManualTaskVersionParametersResponse | 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. |
unlink_parameters_from_task_version
sync(id: UUID, version: str, client: AuthenticatedClient | Client, body: UnlinkParametersFromTaskVersionRequest | Unset = UNSET) -> ManualTaskDefinitionResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
body | UnlinkParametersFromTaskVersionRequest | Unset | UNSET |
- body — Request model for unlinking (removing) specific parameters from a manual task version.
Returns: ManualTaskDefinitionResponse | 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. |