Skip to main content
PATCH
Update Test

Path Parameters

app_id
string
required

The ID of the app

workflow_id
string
required

The ID of the workflow

test_id
string
required

The ID of the test

Query Parameters

verbose
enum<string>[]
Available options:
all

Body

Data to update an existing workflow test

name
string

Name of the workflow test to be created (max 256 characters)

Required string length: 1 - 256
input
object | null

Updated input values for the workflow test

input_default
object | null

Updated default input values for the workflow test

input_context
object | null

Updated context input values for the workflow test

expectations
object[]

Updated list of expectations for the workflow test

Maximum array length: 30
step_key
string | null

Updated starting step key for the workflow test

Response

200 - application/json

Detailed information about a workflow test

id
string
required

Unique identifier for the workflow test

name
string
required

Name of the workflow test

status
enum<string>
required

Status of the workflow test

Available options:
DRAFT,
CANCELLED,
RUNNING,
FAILED,
PASSED
Example:

"PASSED"

step_key
string | null
required

Starting step key for the workflow test

expectations_passing_count
number
required

Number of passing expectations

expectations_failing_count
number
required

Number of failing expectations

workflow_id
string
required

Identifier of the associated workflow

run
object
required

Run details of the workflow test

created_at
string<date> | null
required

Creation date of the workflow test

updated_at
string<date> | null
required

Last update date of the workflow test

input
object | null

Input values for the workflow test

input_default
object | null

Default input values for the workflow test

input_context
object | null

Default input values for the workflow test

expectations
object[]

List of expectations that will be executed for the workflow test