本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 工作项管理/ 查询迭代关联的需求列表或树

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

更新时间：2025-06-26 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

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

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/iterators/{iterator_uri}/issues/batch-query

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID
iterator_uri	是	String	迭代uri

请求参数

表2 请求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	状态名称列表

表3 IssueListPiFilterInfo
参数	是否必选	参数类型	描述
sprints	否	Array of strings	迭代列表
pi_id	否	String	pi的id，层级关系：pi -> 迭代 -> 需求

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
status	String	success\|error;
result	ResultValueListWorkItemVo object	请求返回的数据
error	ApiError object	错误信息
request_id	String	由接口调用方传入，建议使用UUID保证请求的唯一性。
server_address	String	本次请求的受理的服务地址

表5 ResultValueListWorkItemVo
参数	参数类型	描述
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	项目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	DateTime	创建时间
update_time	DateTime	更新时间
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

表7 ApiError
参数	参数类型	描述
code	String	参数解释: 业务失败的错误码取值范围: 不涉及
reason	String	参数解释: 业务失败的提示内容取值范围: 不涉及

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释: 接口调用失败错误码取值范围: 不涉及
error_msg	String	参数解释: 接口调用失败错误信息取值范围: 不涉及

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
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",
  "pi_filter" : [ {
    "value" : "[{\"pi_id\":\"xxx\",\"sprints\":[\"xxx\",\"\"]},{\"pi_id\":\"\",\"sprints\":null}]",
    "type" : "array"
  } ],
  "status_names" : [ "string" ]
}

响应示例

状态码：200

{
  "status" : "string",
  "result" : {
    "value" : [ {
      "name" : "查找产品功能按钮无效",
      "owner" : "e8ad9e7478c94f4eaf90d5a379af9cb1",
      "path" : "1279401,1279405,1279421",
      "start_date" : "2020-11-30",
      "due_date" : "2020-12-15",
      "region" : "cn-north-7",
      "creator" : "efdb403066474ab08836b9eeaaa23bca",
      "updator" : "3c3bb8f0fab340489cc4563ded7ef63c",
      "project_uuid" : "73ad9ecbf32f44928b51a5d2c96720b8",
      "work_item_id" : "2356888",
      "status_id" : "1",
      "status_name" : "新建",
      "tracker_id" : "7",
      "tracker_name" : "Story",
      "iteration_id" : "12233037",
      "module_id" : "167561",
      "severity_id" : "12",
      "severity_name" : "一般",
      "parent_workitem_id" : "1279405",
      "board_id" : "ad0394a7a27842c281a345ec5d2a8f2c",
      "board_name" : "需求",
      "create_time" : "2025-06-19T11:52:49.856Z",
      "update_time" : "2025-06-19T11:52:49.857Z",
      "iteration_name" : "迭代1",
      "module_name" : "模块1",
      "module_path" : "id1/id2",
      "module_path_name" : "模块1/模块2",
      "owner_name" : "测试Tester",
      "have_child_dynamic" : true,
      "has_child" : true,
      "issue_dynamic_count" : 12,
      "case_count" : 10,
      "sequence_id" : "5875482",
      "pi_id" : "883309798865547265",
      "pi_name" : "12233037"
    } ]
  },
  "error" : { },
  "request_id" : "string",
  "server_address" : "string"
}

状态码


状态码	描述
200	OK
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error

错误码

请参见错误码。

父主题： 工作项管理

上一篇：从迭代中移除需求

下一篇：查询项目下需求树(看板)

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

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

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈