Workflows
List Workflows
List workflows
POST
/
workflows
/
list
Python
# pip install deasy-sdk
import os
from deasy import DeasyClient
client = DeasyClient(
base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
username=os.environ["UNSTRUCTURED_USERNAME"],
password=os.environ["UNSTRUCTURED_PASSWORD"],
auth_method="basic",
)
response = client.workflows.list()
print(response.workflows)A valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examples{
"workflows": [
{
"name": "<string>",
"stages": [
{
"jobs": [
{
"endpoint": "<string>",
"endpoint_request_body": {}
}
]
}
],
"cadence": "<string>",
"id": "<string>",
"description": "",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"user_id": "<string>",
"raw_user_id": "<string>",
"raw_env_id": "<string>",
"version": 123,
"latest_run": {
"workflow_id": "<string>",
"user_id": "<string>",
"triggered_by": "<string>",
"job_states": [
{
"jobs": [
{
"status": "pending",
"progress_tracker_id": "<string>"
}
],
"status": "pending"
}
],
"id": "<string>",
"status": "pending",
"errors": [],
"file_count": 123,
"files_processed": 0,
"files_failed": 0,
"connectors_used": [],
"started_at": "<string>",
"completed_at": "<string>",
"jobs_detail": [
{
"tracker_id": "<string>",
"task_type": "<string>",
"status": "<string>",
"start_time": 123,
"end_time": 123,
"data_connector_name": "<string>",
"total_files": 0,
"completed_files": 0,
"failed_files": 0,
"errors": []
}
]
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}project_external_id is required.
- Only workflows created directly under that project are returned; workflows in its sub-projects are not. Projects nest, workflows do not, so there is no recursive listing.
- Archived and proposed workflows are included:
statusis lifecycle metadata, not a filter. - A
limitabove 100 is clamped to 100, not rejected. - A project that does not exist, or that the caller cannot access, returns 404 rather than 403.
Authorizations
BasicAuthBearerAuth & UserIdAuth
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
⌘I
Python
# pip install deasy-sdk
import os
from deasy import DeasyClient
client = DeasyClient(
base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
username=os.environ["UNSTRUCTURED_USERNAME"],
password=os.environ["UNSTRUCTURED_PASSWORD"],
auth_method="basic",
)
response = client.workflows.list()
print(response.workflows)A valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examples{
"workflows": [
{
"name": "<string>",
"stages": [
{
"jobs": [
{
"endpoint": "<string>",
"endpoint_request_body": {}
}
]
}
],
"cadence": "<string>",
"id": "<string>",
"description": "",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"user_id": "<string>",
"raw_user_id": "<string>",
"raw_env_id": "<string>",
"version": 123,
"latest_run": {
"workflow_id": "<string>",
"user_id": "<string>",
"triggered_by": "<string>",
"job_states": [
{
"jobs": [
{
"status": "pending",
"progress_tracker_id": "<string>"
}
],
"status": "pending"
}
],
"id": "<string>",
"status": "pending",
"errors": [],
"file_count": 123,
"files_processed": 0,
"files_failed": 0,
"connectors_used": [],
"started_at": "<string>",
"completed_at": "<string>",
"jobs_detail": [
{
"tracker_id": "<string>",
"task_type": "<string>",
"status": "<string>",
"start_time": 123,
"end_time": 123,
"data_connector_name": "<string>",
"total_files": 0,
"completed_files": 0,
"failed_files": 0,
"errors": []
}
]
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}