Add test cases to a test suite

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

Adds a list of new functional test cases to a test suite. Each test case consists of a test request, client profile, and condition. If you want to use variables within a condition or test request's URL or request header, create the needed variables first. The operation responds with a partial-success 207 response.

Recipes

Create test cases

Open Recipe

Responses

Response body

object

failures

array of objects

required

length ≥ 0

HTTP Problem Details objects indicating causes of failure.

failures*

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.

successes

array of objects

required

length ≥ 0

Lists details on test cases for which the operation succeeded.

successes*

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.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
19
1
curl --request POST \
2
     --url https://hostname/test-management/v3/functional/test-suites/testSuiteId/test-cases \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
[
7
  {
8
    "clientProfile": {
9
      "client": "CHROME",
10
      "geoLocation": "US",
11
      "ipVersion": "IPV4"
12
    },
13
    "testRequest": {
14
      "encodeRequestBody": true,
15
      "requestMethod": "HEAD"
16
    }
17
  }
18
]
19
'


xxxxxxxxxx
63
}
1
{
2
  "failures": [
3
    {
4
      "requestField": "variableName",
5
      "requestValues": [
6
        "contentTypeValue"
7
      ],
8
      "title": "Resource not found",
9
      "type": "resource.not.found"
10
    }
11
  ],
12
  "successes": [
13
    {
14
      "clientProfile": {
15
        "client": "CHROME",
16
        "ipVersion": "IPV4"
17
      },
18
      "condition": {
19
        "conditionExpression": "Response code is one of \"{{successCode.statusCodes}}\""
20
      },
21
      "createdBy": "jperez",
22
      "createdDate": "2021-07-06T10:28:13+0000",
23
      "derivedTestCases": [
24
        {
25
          "clientProfile": {

207Partial success response

400Validation errors.

403Authorization error.

404Resource not found error.