Submit a test run

post

https://{hostname}/test-management/v3/test-runs

Submits a test run for functional testing. With one request you can run the test for a property version, test suite, and functional test case.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Specifies objects you want a test run to execute against an environment.

functional

required

Specifies functional testing objects you want the test run to execute. Depending on what you want to run the functional test for, it may include: propertyManagerExecution, testSuiteExecutions, or testCaseExecutions.

note

string

length between 1 and 200

Notes about the test run.

purgeOnStaging

boolean

Defaults to false

Purges the configuration for the test run. It applies only for targetEnvironment set to STAGING.

sendEmailOnCompletion

boolean

Defaults to true

Sends a notification email after the test run completes.

targetEnvironment

string

enum

required

Environment against which the test run executes the request, either PRODUCTION or STAGING.

Allowed:

Response

Language

URL

Loading…

Response

Choose an example:

application/json

202Process successfully launched.