Update a test suite with child objects

Updates a test suite and included test cases and variables.

Path Params
integer
required

Identifies a test suite. To get this value, run the List test suites operation.

Query Params
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
configs
object

Specifies the Property Manager property associated with the test suite, if applicable.

integer
≥ 0

Number of included test cases executable in a test run. To learn more, see Variable groups.

boolean
required

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

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 included in the test suite.

testCases
string
length between 1 and 4000

Description of the test suite, when available.

string
required
length between 1 and 100

Unique name for each test suite.

variables
array
length ≥ 0

Lists variables included in the test suite.

variables
Responses

Response body
object
configs
object

Specifies the Property Manager property associated with the test suite, if applicable.

propertyManager
object
required

Associated Property Manager property.

string
length ≥ 1

Read-only Username who created the item.

date-time

Read-only ISO 8601 timestamp indicating when the item was created.

integer
≥ 0

Number of included test cases executable in a test run. To learn more, see Variable groups.

boolean
required

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

boolean
required

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

string
length ≥ 1

Read-only Username who last modified the item.

date-time

Read-only ISO 8601 timestamp indicating when the item was last modified.

testCases
array of objects
length ≥ 0

Lists test cases included in the test suite.

testCases
object
clientProfile
object
required

Specifies a client profile included in the test case.

condition
object
required

Specifies a condition.

string
length ≥ 1

Read-only Username who created the item.

date-time

Read-only ISO 8601 timestamp indicating when the item was created.

string
length ≥ 1

Username who last deleted the item.

date-time

ISO 8601 timestamp indicating when the item was deleted.

derivedTestCases
array of objects
length ≥ 0

Read-only Derived test cases. It appears only for test suites with variable groups. To learn more, see Variables.

derivedTestCases
object
clientProfile
object
required

Specifies a client profile included in the test case.

condition
object
required

Specifies a condition.

integer
required
≥ 0

Read-only Order of the derived test case. It applies only for stateful test suites.

setVariables
array of objects
length ≥ 0

Derived test case variables to resolve at runtime. To learn more, see Variables.

setVariables
object
integer
required
≥ 1

Read-only Identifies a variable. To get this value, run the List variables operation.

string
required
length between 1 and 100

Name of the variable.

string
required
length between 1 and 4000

Value of the variable to resolve at runtime.

testRequest
object
required

Specifies a test request included in the test case.

string
length ≥ 1

Read-only Username who last modified the item.

date-time

Read-only ISO 8601 timestamp indicating when the item was last modified.

integer
required
≥ 1

Read-only Order of the test case. It's applied only during a test run for stateful test suites.

setVariables
array of objects
length ≥ 0

Test case variables to resolve at runtime. To learn more, see Variables.

setVariables
object
integer
required
≥ 1

Read-only Identifies a variable. To get this value, run the List variables operation.

string
required
length between 1 and 100

Name of the variable.

string
required
length between 1 and 4000

Value of the variable to resolve at runtime.

integer
required
≥ 1

Read-only Identifies a functional test case.

testRequest
object
required

Specifies a test request included in the test case.

warnings
array of objects
length ≥ 0

Read-only HTTP Problem Details that captures any warnings related to variable groups.

warnings
object
existingEntities
array of objects
length ≥ 0

Lists objects included within the functional test case.

existingEntities
object
string
required

An unique UUID generated for the error object.

string
length ≥ 1

Request field name the error refers to. It can be a URL path or query parameter, or any request payload field name.

requestObjects
array of objects
length ≥ 0

Lists invalid request objects.

requestObjects
object
requestValues
array
length ≥ 0

Lists values corresponding to the requestField.

requestValues
string
required
length ≥ 1

Title of the error.

string
required
length ≥ 1

Type of error.

string
length between 1 and 4000

Description of the test suite, when available.

integer
≥ 1

Read-only Identifies a test suite.

string
required
length between 1 and 100

Unique name for each test suite.

variables
array
length ≥ 0

Lists variables included in the test suite.

variables

Language
Authentication
URL