Help Center/ CodeArts TestPlan/ API Reference/ API/ Test Plan Management/ Querying the Requirement Tree of a Test Plan

Updated on 2023-06-26 GMT+08:00

View PDF

Querying the Requirement Tree of a Test Plan

Function

Queries the requirement list in a test plan.

URI

GET /v1/projects/{project_id}/plans/{plan_id}/issues

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	DevCloud project ID, which uniquely identifies a project. The value contains 32 characters.
plan_id	Yes	String	Test plan ID, which uniquely identifies a test plan. The value is a string of 11 to 34 characters.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Long	Offset, which is the position where the query starts. The value must be greater than or equal to 0. Minimum: 0 Maximum: 999 Default: 0
limit	Yes	Long	Number of items displayed on each page. A maximum of 200 items are supported. Minimum: 1 Maximum: 200 Default: 200

Request Parameters

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

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of TestPlanIssueDetail objects	Requirement list associated with a test plan in a project

**Table 5** TestPlanIssueDetail
Parameter	Type	Description
end_date	String	Deadline
iteration	NameAndId object	Test plan iteration No. and iteration name
module	NameAndId object	Test plan iteration No. and iteration name
name	String	Work item name
owner	NameAndId object	Test plan iteration No. and iteration name
parent_issue	String	Parent work item
plan_id	String	Test plan ID
project_id	String	DevCloud project ID, which uniquely identifies a project. The value contains 32 characters.
region_id	String	Region
severity	NameAndId object	Test plan iteration No. and iteration name
start_date	String	Start date
status	NameAndId object	Test plan iteration No. and iteration name
tracker	NameAndId object	Test plan iteration No. and iteration name
workitem_id	String	Work item ID

**Table 6** NameAndId
Parameter	Type	Description
id	String	Object ID
name	String	object name

Status code: 400

**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

Status code: 401

**Table 8** 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 9** 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 10** 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

Example Requests

get https://{endpoint}/v1/projects/efdb403066474ab08836b9eeaaa23bca/plans/9b26f58ec29943f681804a6628779a23/issues?offset=1&limit=10

Example Responses

Status code: 201

[ {
  "end_date" : "2021-12-11 00:00:00",
  "iteration" : {
    "id" : "ID",
    "name" : "Name"
  },
  "module" : {
    "id" : "ID",
    "name" : "Name"
  },
  "name" : "Work item 1",
  "owner" : {
    "id" : "ID",
    "name" : "Name"
  },
  "parent_issue" : "4192352",
  "plan_id" : "c7c2ddf2ea914164ac6ee76bf11a30ea",
  "project_id" : "9b26f58ec29943f681804a6628779a23",
  "region_id" : "cn-north-7",
  "severity" : {
    "id" : "ID",
    "name" : "Name"
  },
  "start_date" : "2021-12-10 00:00:00",
  "status" : {
    "id" : "ID",
    "name" : "Name"
  },
  "tracker" : {
    "id" : "ID",
    "name" : "Name"
  },
  "workitem_id" : "4192353"
} ]