Help Center/ CodeArts PerfTest/ API Reference/ API/ Global Variable Management/ Creating a Variable
Updated on 2025-12-01 GMT+08:00
View PDF
Share

Creating a Variable

Function

This API is used to create a variable.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    codeartsperftest:cpts:createPerfTestProject

    Write

    cpts *

    -

    -

    -

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 Method of obtaining instructions.

test_suite_id

Yes

Integer

Test project ID, which is the value of project_id in the response body of the API for creating a project.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of CreateVariableRequestBody objects

CreateVariableRequestBody
Table 3 CreateVariableRequestBody

Parameter

Mandatory

Type

Description

id

Yes

Integer

Variable ID, which is the value of json.variable_id in the response body of the API for creating a variable.

name

Yes

String

Variable name.

variable_type

Yes

Integer

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

variable

Yes

Array of objects

Variable value.

is_quoted

Yes

Boolean

Reference status

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

code

String

Response code.

json

CreateVariableResultJson object

Response JSON.

message

String

Response message.
Table 5 CreateVariableResultJson

Parameter

Type

Description

variable_id

Integer

Variable ID, which is the value of json.variable_id in the response body of the API for creating a variable.

Status code: 501

Table 6 Response body parameters

Parameter

Type

Description

-

String

response message

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.