Get a test suite with child objects

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

Exports a test suite with test cases and 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.

createdBy

string

length ≥ 1

Read-only Username who created the item.

createdDate

date-time

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

executableTestCaseCount

integer

≥ 0

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

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.

modifiedBy

string

length ≥ 1

Read-only Username who last modified the item.

modifiedDate

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.

createdBy

string

length ≥ 1

Read-only Username who created the item.

createdDate

date-time

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

deletedBy

string

length ≥ 1

Username who last deleted the item.

deletedDate

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.

order

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

variableId

integer

required

≥ 1

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

variableName

string

required

length between 1 and 100

Name of the variable.

variableValue

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.

modifiedBy

string

length ≥ 1

Read-only Username who last modified the item.

modifiedDate

date-time

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

order

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

variableId

integer

required

≥ 1

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

variableName

string

required

length between 1 and 100

Name of the variable.

variableValue

string

required

length between 1 and 4000

Value of the variable to resolve at runtime.

testCaseId

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

problemId

string

required

An unique UUID generated for the error object.

requestField

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

title

string

required

length ≥ 1

Title of the error.

type

string

required

length ≥ 1

Type of error.

testSuiteDescription

string

length between 1 and 4000

Description of the test suite, when available.

testSuiteId

integer

≥ 1

Read-only Identifies a test suite.

testSuiteName

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

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/test-management/v3/functional/test-suites/testSuiteId/with-child-objects \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response provides the test suite with child objects.

400Validation errors.

403Authorization error.

404Resource not found error.