Data API — Workflows
workflows_create
sync(client: AuthenticatedClient | Client, body: CreateWorkflowRequest | Unset = UNSET) -> ProblemDetails | WorkflowResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
body | CreateWorkflowRequest | Unset | UNSET |
- body — Information for creating a workflow
Returns: ProblemDetails | WorkflowResponse | 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. |
workflows_list
sync(client: AuthenticatedClient | Client, organization_id: UUID | Unset = UNSET, created_by_user_id: UUID | Unset = UNSET, last_modified_by_user_id: UUID | Unset = UNSET, name: str | Unset = UNSET, description: str | Unset = UNSET, thumbnail_ref: str | Unset = UNSET, image_ref: str | Unset = UNSET, version: int | Unset = UNSET, is_workflow_requestable: bool | Unset = UNSET, version_group_id: UUID | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[WorkflowListItemResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
organization_id | UUID | Unset | UNSET |
created_by_user_id | UUID | Unset | UNSET |
last_modified_by_user_id | UUID | Unset | UNSET |
name | str | Unset | UNSET |
description | str | Unset | UNSET |
thumbnail_ref | str | Unset | UNSET |
image_ref | str | Unset | UNSET |
version | int | Unset | UNSET |
is_workflow_requestable | bool | Unset | UNSET |
version_group_id | UUID | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[WorkflowListItemResponse] | 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. |
workflow_delete
sync(workflow_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_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. |
workflow_describe
sync(workflow_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkflowResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkflowResponse | 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. |
workflow_publish
sync(workflow_id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | WorkflowResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
client | AuthenticatedClient | Client | required |
Returns: ProblemDetails | WorkflowResponse | 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. |
workflow_update
sync(workflow_id: UUID, client: AuthenticatedClient | Client, body: UpdateWorkflowRequest | Unset = UNSET) -> ProblemDetails | WorkflowResponse | list[ErrorResponse] | NoneParameter | Type | Default |
|---|---|---|
workflow_id | UUID | required |
client | AuthenticatedClient | Client | required |
body | UpdateWorkflowRequest | Unset | UNSET |
- body — Information for updating a workflow
Returns: ProblemDetails | WorkflowResponse | 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. |