查询迭代关联的需求列表或树
功能介绍
查询迭代关联的需求列表或树
URI
POST /GT3KServer/v4/{project_id}/iterators/{iterator_id}/issues/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
iterator_id |
是 |
String |
迭代uri |
|
project_id |
是 |
String |
参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 约束限制 不涉及 取值范围 字符串长度不少于1，不超过100000 默认取值 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
状态名称列表 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
value |
Array of WorkItemVo objects |
实际的数据类型：单个对象，集合 或 NULL |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 业务失败的错误码 取值范围: 不涉及 |
|
reason |
String |
参数解释: 业务失败的提示内容 取值范围: 不涉及 |
请求示例
post https://{endpoint}/GT3KServer/v4/f3087a82b44744c29a1bd69ab6ada154/iterators/9b26f58ec29943f681804a6628779a23/issues/batch-query
{
"owner" : "e8ad9e7478c94f4eaf90d5a379af9cb1",
"issue_id" : "efdb403066474ab08836b9eeaaa23bca",
"page_no" : 1,
"page_size" : 1000,
"key_word" : "管理",
"iteration_id" : "10415967",
"severity_id" : "12",
"status_id" : "1",
"module_id" : "261469",
"status_ids" : "1",
"module_ids" : "261469",
"status_names" : [ "string" ]
}响应示例
状态码：200
OK
{
"value" : [ {
"name" : "Story1",
"owner" : "dfc5347b9b16491e942ce55ce7f79dbc",
"path" : "1413918,1413919",
"region" : {
"region" : null
},
"creator" : "dfc5347b9b16491e942ce55ce7f79dbc",
"updator" : "dfc5347b9b16491e942ce55ce7f79dbc",
"project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d",
"work_item_id" : "1413919",
"status_id" : "1",
"status_name" : "新建",
"tracker_id" : "7",
"tracker_name" : "Story",
"severity_id" : "12",
"severity_name" : "一般",
"parent_workitem_id" : "1413918",
"create_time" : "2025-02-28 16:05:21",
"update_time" : "2025-02-28 16:05:21",
"owner_name" : "TMSS01",
"have_child_dynamic" : false,
"has_child" : false,
"issue_dynamic_count" : 0,
"case_count" : 0
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
