Data API — v2 Workflows
v2_workflows_check_import_conflicts
sync(client: AuthenticatedClient | Client, body: V2WorkflowsCheckImportConflictsFilesBody | V2WorkflowsCheckImportConflictsJsonBody | Unset = UNSET) -> ProblemDetails | WorkflowImportConflictResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | V2WorkflowsCheckImportConflictsFilesBody | V2WorkflowsCheckImportConflictsJsonBody | Unset | UNSET |
Returns: ProblemDetails | WorkflowImportConflictResponse | 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. |
v2_workflows_check_import_conflicts_zip
sync(client: AuthenticatedClient | Client, body: V2WorkflowsCheckImportConflictsZipFilesBody | V2WorkflowsCheckImportConflictsZipJsonBody | Unset = UNSET) -> ProblemDetails | WorkflowImportConflictResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | V2WorkflowsCheckImportConflictsZipFilesBody | V2WorkflowsCheckImportConflictsZipJsonBody | Unset | UNSET |
Returns: ProblemDetails | WorkflowImportConflictResponse | 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. |
v2_workflows_create_draft
sync(client: AuthenticatedClient | Client, body: WorkflowV2CreateRequest | Unset = UNSET) -> ProblemDetails | WorkflowSummaryResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | WorkflowV2CreateRequest | Unset | UNSET |
- body — Request model for creating a new workflow draft.
Returns: ProblemDetails | WorkflowSummaryResponse | 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. |
v2_workflows_delete
sync(workflow_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: 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. |
v2_workflows_export_version
sync(workflow_id: UUID, version: str, client: AuthenticatedClient | Client) -> File | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
Returns: File | 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. |
v2_workflows_export_version_zip
sync(workflow_id: UUID, version: str, client: AuthenticatedClient | Client) -> File | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
Returns: File | 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. |
v2_workflows_get_version
sync(workflow_id: UUID, version: str, client: AuthenticatedClient | Client) -> ProblemDetails | WorkflowV2Response | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
version | str | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkflowV2Response | 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. |
v2_workflows_import
sync(client: AuthenticatedClient | Client, body: V2WorkflowsImportFilesBody | V2WorkflowsImportJsonBody | Unset = UNSET) -> ImportWorkflowResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | V2WorkflowsImportFilesBody | V2WorkflowsImportJsonBody | Unset | UNSET |
Returns: ImportWorkflowResponse | 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. |
v2_workflows_import_zip
sync(client: AuthenticatedClient | Client, body: V2WorkflowsImportZipFilesBody | V2WorkflowsImportZipJsonBody | Unset = UNSET) -> ImportWorkflowResponse | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | V2WorkflowsImportZipFilesBody | V2WorkflowsImportZipJsonBody | Unset | UNSET |
Returns: ImportWorkflowResponse | 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. |
v2_workflows_latest
sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowSummaryResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowSummaryResponse] | 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. |
v2_workflows_latest_published
sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowSummaryResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowSummaryResponse] | 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. |
v2_workflows_list_versions
sync(workflow_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | list[ErrorResponse] | list[WorkflowVersionResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowVersionResponse] | 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. |
v2_workflows_migrate
sync(client: AuthenticatedClient | Client, dry_run: bool | Unset = UNSET) -> ProblemDetails | WorkflowMigrationResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
dry_run | bool | Unset | UNSET |
Returns: ProblemDetails | WorkflowMigrationResponse | 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. |
v2_workflows_publish_draft
sync(workflow_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkflowSummaryResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkflowSummaryResponse | 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. |
v2_workflows_search_versions
sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, version: str | Unset = UNSET, version_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowVersionListItemResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
name | str | Unset | UNSET |
version | str | Unset | UNSET |
version_id | UUID | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowVersionListItemResponse] | 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. |