Workflows API
Cancel a Workflow Test
Cancel a running workflow test by its ID.
POST
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
/
tests
/
{test_id}
/
cancel
Path Parameters
app_id
string
requiredThe ID of the app
workflow_id
string
requiredThe ID of the workflow
test_id
string
requiredThe ID of the test
Query Parameters
verbose
enum<string>[]
Available options:
all
Response
200 - application/json
id
string
requiredUnique identifier for the workflow test
name
string
requiredName of the workflow test
status
enum<string>
requiredStatus of the workflow test
Available options:
DRAFT
, CANCELLED
, RUNNING
, FAILED
, PASSED
input
object | null
Input values for the workflow test
input_default
object | null
Default input values for the workflow test
expectations
object[]
List of expectations that will be executed for the workflow test
expectations_passing_count
number
requiredNumber of passing expectations
expectations_failing_count
number
requiredNumber of failing expectations
workflow_id
string
requiredIdentifier of the associated workflow
run
object
requiredRun details of the workflow test
created_at
string | null
requiredCreation date of the workflow test
updated_at
string | null
requiredLast update date of the workflow test
Was this page helpful?