-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation: Workflow Manager
David edited this page May 21, 2023
·
1 revision
Get Workflow List
Get all workflows endpoint.
List of workflow pydantic output models, might be empty
Code | Description |
---|---|
200 | Successful Response |
Create Workflow
Create new workflow endpoint.
payload Workflow pydantic base model
Workflow pydantic output model
HTTPException 404: Creation unsuccessful
Code | Description |
---|---|
201 | Successful Response |
422 | Validation Error |
Get Workflow
Get workflow endpoint.
workflow_id Id of the workflow object to be returned
Workflow pydantic output model
HTTPException 404: Not found
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
workflow_id | path | Yes | integer |
Code | Description |
---|---|
200 | Successful Response |
422 | Validation Error |
Delete Workflow
Delete workflow endpoint.
workflow_id Id of workflow to be deleted
HTTPException 404: Not found
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
workflow_id | path | Yes | integer |
Code | Description |
---|---|
204 | Successful Response |
422 | Validation Error |
Update Workflow
Update existing workflow endpoint.
workflow_id Id of the workflow to be updated payload Data to be updated, workflow pydantic base model
Workflow pydantic output model.
HTTPException 404: Not found
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
workflow_id | path | Yes | integer |
Code | Description |
---|---|
200 | Successful Response |
422 | Validation Error |
Readiness
Readiness health endpoint.
Inspects sqlalchemy engine and check if workflow table exists.
Status docstring
HTTPException 500: Workflow table does not exist
Code | Description |
---|---|
200 | Successful Response |