文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试计划管理/ 查询迭代关联的需求列表或树
更新时间:2024-11-19 GMT+08:00
分享

查询迭代关联的需求列表或树

功能介绍

查询迭代关联的需求列表或树

URI

POST /GT3KServer/v4/{project_id}/iterators/{iterator_id}/issues/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

iterator_id

String

迭代uri

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

owner

String

过滤条件:处理人

issue_id

String

需求ID

page_no

Integer

页码

page_size

Integer

每页展示条数

key_word

String

关键字

iteration_id

String

过滤条件:迭代ID

severity_id

String

过滤条件:重要程度ID

status_id

String

过滤条件:状态ID

module_id

String

过滤条件:模块ID

status_ids

String

过滤条件:状态ID多个条件,每个条件取或,-2代表搜索未设置

module_ids

String

过滤条件:模块ID多个,每个条件取或,-2代表搜索未设置

pi_filter

Array of IssueListPiFilterInfo objects

迭代、pi过滤条件

status_names

Array of strings

状态名称列表

表4 IssueListPiFilterInfo

参数

是否必选

参数类型

描述

sprints

Array of strings

迭代列表

pi_id

String

pi的id,层级关系:pi -> 迭代 -> 需求

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

value

Array of WorkItemVo objects

实际的数据类型:单个对象,集合 或 NULL

表6 WorkItemVo

参数

参数类型

描述

name

String

工作项名称

owner

String

处理人

path

String

工作项路径

start_date

String

预计开始日期

due_date

String

预计结束日期

region

String

逻辑region,外部使用公有云实际区域,内部使用默认值

creator

String

创建人

updator

String

更新人

project_uuid

String

项目ID,外部使用项目ID,内部使用默认值

work_item_id

String

工作项编号

status_id

String

状态ID

status_name

String

状态

tracker_id

String

类型ID

tracker_name

String

类型

iteration_id

String

迭代ID

module_id

String

模块ID

severity_id

String

重要程度ID

severity_name

String

重要程度

parent_workitem_id

String

父工作项编号

board_id

String

看板ID

board_name

String

看板

create_time

String

创建时间

update_time

String

更新时间

iteration_name

String

迭代名

module_name

String

模块名

module_path

String

模块path

module_path_name

String

模块路径名称

owner_name

String

处理人

have_child_dynamic

Boolean

父工作项下是否有子工作项包含动态

has_child

Boolean

父工作项下是否有子工作项

issue_dynamic_count

Integer

需求动态数量

case_count

Integer

用例数量

sequence_id

String

xBoard项目工作项序列号

pi_id

String

pi的id,层级关系:pi -> 迭代 -> 需求

pi_name

String

迭代ID

状态码: 400

表7 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 401

表8 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 404

表9 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 500

表10 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档