Modifying a Variable

Function

This API is used to modify a variable.

URI

PUT /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 UpdateVariableRequestBody objects	UpdateVariableRequestBody

**Table 3** UpdateVariableRequestBody
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.

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

Modifying the 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

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

Example Responses

Status code: 201

success

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

Status Codes

Status Code	Description
201	success
501	unknown error

Error Codes

See Error Codes.

Parent topic: Global Variable Management

Previous topic: Creating a Variable

Next topic: Deleting a Global Variable

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot