On this page

Show all

Help Center/ CodeArts TestPlan/ API Reference/ API/ Test Plan Management/ Adding Test Cases in Batches to a Plan

Adding Test Cases in Batches to a Plan

Updated on 2025-01-08 GMT+08:00

View PDF

Function

Adds test cases in batches to a plan.

URI

POST /v1/projects/{project_id}/plans/{plan_id}/testcases/batch-add

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Uniquely identifies a project. The value contains 32 characters. For details about how to obtain the value, see Obtaining a Project ID.
plan_id	Yes	String	Unique ID of a plan. The value contains 11 to 34 characters.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Call IAM to obtain the user token (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
service_id	Yes	Integer	Service ID returned by the API for registering a test service
testcase_id_list	Yes	Array of strings	Number of cases contained in the plan. The array length is less than 50. Only one test type can be contained.

Response Parameters

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code displayed after an API fails to be called
error_msg	String	Error message displayed after an API fails to be called

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code displayed after an API fails to be called
error_msg	String	Error message displayed after an API fails to be called

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code displayed after an API fails to be called
error_msg	String	Error message displayed after an API fails to be called

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code displayed after an API fails to be called
error_msg	String	Error message displayed after an API fails to be called
error_detail	ErrorDetailInfo object	Details about failed batch operations. This structure is unavailable when all operations fail.

**Table 8** ErrorDetailInfo
Parameter	Type	Description
failed	Array of ErrorCaseInfoBean objects	Details about the resources that fail to be operated in batches

**Table 9** ErrorCaseInfoBean
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message
testcase_id	String	Failed resource information

Example Requests

Add test cases in batches to a plan.

post https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans/9b26f58ec29943f681804a6628779a23/testcases/batch-add

{
  "service_id" : 13,
  "testcase_id_list" : [ "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de", "97b82412f1ca4628803b918c27ed09de" ]
}

Example Responses

Status code: 500

Internal Server Error

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "Error information about the interface invoking failure",
  "error_detail" : {
    "failed" : [ {
      "error_code" : "CLOUDTEST.00000001",
      "error_msg" : "Returned error information",
      "testcase_id" : "efdb403066474ab08836b9eeaaa23bca"
    } ]
  }
}

Status Codes

Status Code	Description
204	No Content
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Test Plan Management

Previous topic: Test Plan Management

Next topic: Creating a Plan in a Project

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