Create a test suite

post https://{hostname}/test-management/v3/functional/test-suites

Creates an empty test suite. To add objects to the newly created test suite, run the Add test cases to a test suite and Add variables to a test suite operations.

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

required

length ≥ 1

Read-only Username who created the item.

createdDate

date-time

required

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.

executableTestCaseCount

integer

required

≥ 0

Read-only 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.

testSuiteDescription

string

length between 1 and 4000

Description of the test suite, when available.

testSuiteId

integer

required

≥ 1

Read-only Identifies a test suite.

testSuiteName

string

required

length between 1 and 100

Unique name for each test suite.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://hostname/test-management/v3/functional/test-suites \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "isLocked": true,
8
  "isStateful": true
9
}
10
'


xxxxxxxxxx
19
 
1
{
2
  "configs": {
3
    "propertyManager": {
4
      "propertyId": 1234,
5
      "propertyName": "config_user8",
6
      "propertyVersion": 4
7
    }
8
  },
9
  "createdBy": "jperez",
10
  "createdDate": "2021-07-06T10:28:13+0000",
11
  "executableTestCaseCount": 1,
12
  "isLocked": false,
13
  "isStateful": false,
14
  "modifiedBy": "jperez",
15
  "modifiedDate": "2021-07-06T10:29:20+0000",
16
  "testSuiteDescription": "This test suite performs basic check of www.user8.example.com",
17
  "testSuiteId": 284,
18
  "testSuiteName": "www.user8.example.com test suite"
19
}

201The response provides the created test suite.

400Validation errors.

403Authorization error.

404Resource not found error.