Get the test catalog template

get

https://{hostname}/test-management/v3/functional/test-catalog/template

Returns the test catalog template used for creating conditions. To learn more, see Test Center concepts and Example: create a condition.

Responses

Response body

object

conditionTypes

array of objects

required

length ≥ 1

Lists supported condition types and their details.

conditionTypes*

object

conditionExpressions

array of objects

required

length ≥ 0

Lists supported condition expressions and examples.

conditionExpressions*

object

conditionExpression

string

required

length ≥ 1

Condition expression template.

examples

array of strings

required

length ≥ 1

Lists examples of condition expressions.

examples*

conditionType

string

required

length ≥ 1

Unique name for the condition type. To learn more about it, see the list of available conditions.

label

string

length ≥ 1

Label for the condition type.

placeHolders

array of objects

required

length ≥ 0

Lists details on supported values for you to provide instead of placeholders in conditionExpression.

placeHolders*

object

availableValues

array

required

length ≥ 0

Lists predefined values you can use instead of the placeholder.

availableValues*

String

Integer

isCustomValueSupported

boolean

required

Whether you can provide your own values, or if you're limited to values listed in availableValues.

placeHolder

string

required

length ≥ 1

Placeholder name, the same as in conditionExpression.

valueDataType

string

enum

required

Specifies whether availableValues are STRING or INTEGER. This also specifies the type of data you need to provide instead of placeholders, if isCustomValueSupported is true.

STRING INTEGER

valueInputType

string

enum

required

Specifies whether valueDataType supports SINGLE_VALUE or MULTIPLE_VALUE.

SINGLE_VALUE MULTIPLE_VALUE

valueSeparator

string

length ≥ 1

Specifies the separator when valueInputType is MULTIPLE_VALUE.

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-catalog/template \
3
     --header 'accept: application/json'


xxxxxxxxxx
1538
}
1
{
2
  "conditionTypes": [
3
    {
4
      "conditionExpressions": [
5
        {
6
          "conditionExpression": "Response code is one of \"responseCodes\"",
7
          "examples": [
8
            "Response code is one of \"401, 403, 404, 500, 501, 502\"",
9
            "Response code is one of \"200\""
10
          ]
11
        }
12
      ],
13
      "conditionType": "RESPONSE_CODE",
14
      "label": "Response code",
15
      "placeHolders": [
16
        {
17
          "availableValues": [
18
            200,
19
            300,
20
            400,
21
            500
22
          ],
23
          "isCustomValueSupported": true,
24
          "placeHolder": "responseCodes",
25
          "valueDataType": "INTEGER",
26
          "valueInputType": "MULTIPLE_VALUE",
27
          "valueSeparator": ","
28
        }
29
      ]
30
    },
31
    {
32
      "conditionExpressions": [
33
        {
34
          "conditionExpression": "Response header \"headerName\" exists",
35
          "examples": [
36
            "Response header \"enter a value\" exists"
37
          ]
38
        },
39
        {
40
          "conditionExpression": "Response header \"headerName\" has a value",
41
          "examples": [
42
            "Response header \"enter a value\" has a value"
43
          ]
44
        },
45
        {
46
          "conditionExpression": "Response header \"headerName\" has no value",
47
          "examples": [
48
            "Response header \"enter a value\" has no value"
49
          ]

200The response returns the test catalog template.

403Authorization error.