查询迭代关联的需求列表或树 - ShowIssueTreeFour
功能介绍
查询迭代关联的需求列表或树
调用方法
请参见如何调用API。
URI
POST /v4/{project_id}/iterators/{iterator_uri}/issues/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
|
iterator_uri |
是 |
String |
迭代uri |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释 状态名称列表 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
security_level_policy |
否 |
Boolean |
参数解释 是否过滤用户不可见的高密数据 约束限制 不涉及 取值范围 true||false 默认取值 true |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
value |
Array of WorkItemVo objects |
请求返回的数据 |
|
total |
Integer |
数据总数 |
|
page_no |
Integer |
页码 |
|
page_size |
Integer |
每页数据行数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释 工作项名称 取值范围 不涉及 |
|
owner |
String |
参数解释 处理人 取值范围 不涉及 |
|
path |
String |
参数解释 工作项路径 取值范围 不涉及 |
|
start_date |
String |
参数解释 预计开始日期 取值范围 不涉及 |
|
due_date |
String |
参数解释 预计结束日期 取值范围 不涉及 |
|
region |
String |
参数解释 逻辑region 取值范围 使用公有云实际区域 |
|
creator |
String |
参数解释 创建人 取值范围 不涉及 |
|
updator |
String |
参数解释 更新人 取值范围 不涉及 |
|
project_uuid |
String |
参数解释 项目UUID 取值范围 项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目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 |
参数解释 父工作项下是否有子工作项包含动态 取值范围 true:是 false:否 |
|
has_child |
Boolean |
参数解释 父工作项下是否有子工作项 取值范围 true:有子工作项 false:无子工作项 |
|
issue_dynamic_count |
Integer |
参数解释 需求动态数量 取值范围 不涉及 |
|
case_count |
Integer |
参数解释 用例数量 取值范围 不涉及 |
|
sequence_id |
String |
参数解释 xBoard项目工作项序列 取值范围 不涉及号 |
|
pi_id |
String |
参数解释 pi的id 取值范围 层级关系：pi -> 迭代 -> 需求 |
|
pi_name |
String |
参数解释 迭代ID 取值范围 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
post https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/iterators/2e8b14eb90/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
{
"total" : 1,
"page_no" : 1,
"page_size" : 5,
"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 |
错误码
请参见错误码。
