Help Center/ CodeArts PerfTest/ API Reference/ API/ Global Variable Management/ Creating a Variable
Updated on 2024-04-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Variable

Function

This API is used to create a variable.

URI

POST /v1/{project_id}/variables/{test_suite_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Minimum: 0

Maximum: 64

test_suite_id

Yes

Integer

Test project ID.

Minimum: 0

Maximum: 2147483647

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of CreateVariableRequestBody objects

Request body for creating a global variable.
Table 3 CreateVariableRequestBody

Parameter

Mandatory

Type

Description

id

Yes

Integer

Variable ID.

Minimum: 0

Maximum: 2147483647

name

Yes

String

Variable name.

Minimum: 1

Maximum: 42

variable_type

Yes

Integer

Variable type (1: integer; 2: enumeration; 3: file; 5: text).

Minimum: 0

Maximum: 2147483647

variable

Yes

Array of objects

Variable value.

Array Length: 0 - 1024

is_quoted

Yes

Boolean

Reference status

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

code

String

Response code.

Minimum: 0

Maximum: 1024

json

CreateVariableResultJson object

Response JSON.

message

String

Response message.

Minimum: 0

Maximum: 1024
Table 5 CreateVariableResultJson

Parameter

Type

Description

variable_id

Integer

Variable ID.

Minimum: 0

Maximum: 2147483647

Example Requests

Creating a global variable named varTest. The ID of the project to which the variable belongs is 1, the variable type is integer, and the variable value ranges from 1 to 10.

/v1/projectId/variables/1

[ {
  "name" : "varTest",
  "variable_type" : 1,
  "variable" : [ 1, 10 ],
  "is_quoted" : false
} ]

Example Responses

Status code: 201

success

{
  "code" : "SVCSTG.CPTS.0000000",
  "json" : {
    "variable_id" : 44245
  },
  "message" : "success"
}

Status Codes

Status Code

Description

201

success

501

unknown error

Error Codes

See Error Codes.