文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试计划管理/ 查询某个测试计划下的需求树
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

查询某个测试计划下的需求树

功能介绍

查询某个测试计划下的需求列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及

plan_id

是

String

参数解释:

测试计划id，对应测试计划管理页面创建的测试计划对象以及版本管理中创建的版本对象，测试用例列表页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testcase?branch_id={branch_id}&testplan_id={testplan_id}中变量branch_id/testplan_id的值

约束限制:

不涉及

取值范围:

长度11-34位字符（字母和数字）

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Long

参数解释:

起始偏移量，表示从此偏移量开始查询，

约束限制:

不涉及

取值范围:

offset大于等于0，小于等于2000000。

默认取值:

不涉及

limit

是

Long

参数解释:

每页显示的条目数量,最大支持100条，表示从此偏移量开始查询，

约束限制:

不涉及

取值范围:

0-100

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of TestPlanIssueDetail objects

项目下某个测试计划关联的需求列表
表5 TestPlanIssueDetail

参数

参数类型

描述

end_date

String

预计结束日期

iteration

NameAndId object

测试计划迭代编号与迭代名称

module

NameAndId object

测试计划迭代编号与迭代名称

name

String

工作项名称

owner

NameAndId object

测试计划迭代编号与迭代名称

parent_issue

String

父工作项

plan_id

String

测试计划id

project_id

String

项目id，项目唯一标识，固定长度32位字符

region_id

String

region信息

severity

NameAndId object

测试计划迭代编号与迭代名称

start_date

String

预计开始日期

status

NameAndId object

测试计划迭代编号与迭代名称

tracker

NameAndId object

测试计划迭代编号与迭代名称

workitem_id

String

工作项id
表6 NameAndId

参数

参数类型

描述

id

String

对象编号

name

String

对象名称

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

查询某个测试计划下的需求树

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

响应示例

状态码： 201

OK

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

状态码

状态码

描述

201

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试计划管理

相关文档