Workflow Data
Routes
Resource |
Operation |
Description |
|---|---|---|
Workflow Data Database |
Get workflow logs and steps |
|
GET /ivoryos/executions/records/(int:workflow_id)/steps_data_csv |
Download workflow step data CSV |
|
Download workflow log file |
||
Get workflow data for plotting |
||
Delete an execution record |
||
Workflow Execution Database |
List all execution records |
|
Workflow data |
download a workflow data file (.CSV) |
Docs
- GET /ivoryos/executions/records
List Workflows
- GET /executions/records
Retrieve a list of all past workflow execution records, with optional keyword searching.
- Query Parameters:
keyword – Optional search term to filter workflows by name.
page – The page number for pagination.
- Status Codes:
200 OK – Returns a list of workflow records (HTML or JSON).
- GET /ivoryos/executions/records/(int: workflow_id)
Workflow Logs
- GET /executions/records/<int:workflow_id>
Retrieve detailed logs, execution steps, and phases for a specific workflow by its ID.
- Parameters:
workflow_id – The unique ID of the workflow run.
- Status Codes:
200 OK – Returns the workflow logs and phase details.
404 Not Found – Workflow record not found.
- GET /ivoryos/executions/records/(int: workflow_id)/steps_data_csv
- GET /executions/records/<int:workflow_id>/steps_data_csv
Download a CSV export of step inputs, outputs, and timing for a workflow run.
- Parameters:
workflow_id – The unique ID of the workflow run.
- Status Codes:
200 OK – Returns a CSV file.
404 Not Found – Workflow record not found.
- GET /ivoryos/executions/records/(int: workflow_id)/logs
- GET /executions/records/<int:workflow_id>/logs
Download the log file associated with a workflow run.
- Parameters:
workflow_id – The unique ID of the workflow run.
- Status Codes:
200 OK – Returns a log file.
404 Not Found – Workflow record or log file not found.
- GET /ivoryos/executions/data/(int: workflow_id)
Workflow Phase Data
- GET /executions/data/<int:workflow_id>
Get normalized data from the ‘main’ phases of a workflow for visualization and plotting.
- Parameters:
workflow_id – The unique ID of the workflow run.
- Status Codes:
200 OK – Returns a JSON object with plotting data.
- DELETE /ivoryos/executions/records/(int: workflow_id)
Delete Workflow Record
- DELETE /executions/records/<int:workflow_id>
Permanently delete a workflow execution record from the database by its ID.
- Parameters:
workflow_id – The unique ID of the workflow run.
- Status Codes:
200 OK – Returns success on deletion.
404 Not Found – Workflow record not found.
- GET /ivoryos/files/execution-data/(string: filename)
- GET /files/execution-data/<string:filename>
- Parameters:
filename (str) – workflow data filename
# :status 302: load pseudo deck and then redirects to
GET /ivoryos/executions/records