Collections
Records
Workflows
- GETDiscover Workflows
- GETGet Discoverable Workflow
- GETGet Discoverable Workflow Version
- POSTRun Discoverable Workflow
- POSTCancel a Discoverable Workflow Run
- GETGet Workflows
- GETGet a Workflow
- GETGet Workflow Runs
- POSTRun a Workflow
- GETGet a Workflow Run
- POSTReplay a Workflow Run
- POSTCancel a Workflow Run
- PATCHUpdate Run Data Retention Configuration
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Files
Tests
Update Test
Update a specific workflow test by its ID.
PATCH
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
/
tests
/
{test_id}
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"status": "PASSED",
"input": {},
"input_default": {},
"input_context": {},
"step_key": "<string>",
"expectations": [
{
"key": "<string>",
"name": "<string>",
"expectation_id": "<string>",
"script": "<string>",
"output": "<any>",
"logs": [
"<any>"
],
"status": "PASSED"
}
],
"expectations_passing_count": 123,
"expectations_failing_count": 123,
"workflow_id": "<string>",
"run": {
"id": "<string>",
"result": "<any>",
"input": {},
"output": {},
"status": "RUNNING",
"origin": "WORKFLOW",
"error": "<string>",
"started_at": "2023-12-25",
"ended_at": "2023-12-25",
"app_id": "<string>",
"workflow_app_id": "<string>",
"workflow_id": "<string>",
"workflow_version_draft": {
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"collection_id": "<string>",
"record_id": "<string>",
"version": 123,
"usage": {
"total": 123,
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
{}
]
}
],
"steps": {}
},
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"retention_due_at": "2023-12-25",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
Path Parameters
The ID of the app
The ID of the workflow
The ID of the test
Query Parameters
Show child attributes
Show child attributes
Body
Data to update an existing workflow test
Response
200 - application/json
Detailed information about a workflow test
Was this page helpful?
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"status": "PASSED",
"input": {},
"input_default": {},
"input_context": {},
"step_key": "<string>",
"expectations": [
{
"key": "<string>",
"name": "<string>",
"expectation_id": "<string>",
"script": "<string>",
"output": "<any>",
"logs": [
"<any>"
],
"status": "PASSED"
}
],
"expectations_passing_count": 123,
"expectations_failing_count": 123,
"workflow_id": "<string>",
"run": {
"id": "<string>",
"result": "<any>",
"input": {},
"output": {},
"status": "RUNNING",
"origin": "WORKFLOW",
"error": "<string>",
"started_at": "2023-12-25",
"ended_at": "2023-12-25",
"app_id": "<string>",
"workflow_app_id": "<string>",
"workflow_id": "<string>",
"workflow_version_draft": {
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"workflow_version": {
"id": "<string>",
"app_id": "<string>",
"workflow_id": "<string>",
"description": "<string>",
"version": 123,
"rollback_version": 123,
"notes": "<string>",
"created_by": {
"id": "<string>",
"name": "<string>"
},
"created_at": "2023-12-25",
"key": "<string>",
"input": {},
"input_default": {},
"input_options": {
"display": {
"field": "inline",
"container": "grid",
"hidden": true
}
},
"steps": [
{
"type": "note",
"key": "<string>",
"display": "expanded",
"conditional": "<string>",
"loop": "<string>",
"throw_on_error": true,
"input_connected": true,
"destinations": [
"<string>"
],
"position": [
123
],
"size": [
101
],
"auto": {
"provider": "<string>",
"model": "<string>",
"temperature": 1
},
"note": "<string>"
}
]
},
"collection_id": "<string>",
"record_id": "<string>",
"version": 123,
"usage": {
"total": 123,
"calls": [
{
"id": "<string>",
"total": 123,
"calls": [
{}
]
}
],
"steps": {}
},
"retention": {
"max_age_in_seconds": 3600,
"preserve_on_failure": true
},
"retention_due_at": "2023-12-25",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
Assistant
Responses are generated using AI and may contain mistakes.