Create a test suite with child objects

post

https://{hostname}/test-management/v3/functional/test-suites/with-child-objects

Creates a test suite with test cases and variables. You can use the Generate a test suite with child objects operation to create a default test suite for a property version and then import it with this operation. The operation responds with a partial-success 207 response. Once you create the test suite, you can continue adding more objects to it with the Add test cases to a test suite and Add variables to a test suite operations.

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

Configures a test suite with test cases and variables.

configs

object

Specifies a Property Manager property to associate with a test suite.

isLocked

boolean

required

Locks the test suite so that only designated owners or editors can modify it.

isStateful

boolean

required

Runs the test suite statefully, retaining cookies and session data for subsequent test cases within the test suite.

testCases

array of objects

length ≥ 0

Lists test cases and included objects: conditions, test requests, and client profiles.

testCases

testSuiteDescription

string

length between 1 and 4000

Description of the test suite, when available.

testSuiteName

string

required

length between 1 and 100

Unique name for each test suite.

variables

array

length ≥ 1

Generated variables referenced in a test case's testRequestUrl, headerName, headerValue, requestBody, or conditionExpression as a substitute for placeholders. To learn more, see Variables.

variables

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

207Partial success response

400Validation errors.

403Authorization error.

404Resource not found error.