文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试计划管理/ 查询迭代计划列表，包含统计信息（2.0）

更新时间：2025-07-24 GMT+08:00

在线调试

CLI示例

查看PDF

查询迭代计划列表，包含统计信息（2.0）

功能介绍

查询迭代计划列表，包含统计信息，2.0版本接口

调用方法

请参见如何调用API。

URI

POST /v4/iterators/batch-query

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：字符串长度不少于1，不超过10万。默认取值：不涉及。

表2 请求Body参数
参数	是否必选	参数类型	描述
name	否	String	参数解释迭代计划名称（支持模糊搜索）约束限制不涉及取值范围不涉及默认取值不涉及
filter	否	IteratorListFilterInfo object	参数解释过滤信息约束限制不涉及取值范围不涉及默认取值不涉及
own	否	Boolean	参数解释是否是我的约束限制不涉及取值范围 true:是 false:否默认取值不涉及
branch_uri	否	String	参数解释分支URI 约束限制不涉及取值范围 11-34位字母/数字默认取值不涉及
iterator_uri	否	String	参数解释迭代计划URI 约束限制不涉及取值范围 11-34位字母/数字默认取值不涉及
owner_ids	否	Array of strings	参数解释迭代计划责任人集合约束限制不涉及取值范围不涉及默认取值不涉及
project_uuid	是	String	参数解释项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制不涉及取值范围 32位字符（字母和数字）默认取值不涉及
current_stage	否	String	参数解释迭代计划所处节点约束限制不涉及取值范围不涉及默认取值不涉及
page_no	否	Integer	参数解释当前页数约束限制不涉及取值范围不涉及默认取值不涉及
page_size	否	Integer	参数解释每页条数约束限制不涉及取值范围不涉及默认取值不涉及

表3 IteratorListFilterInfo
参数	是否必选	参数类型	描述
pi_sprints	否	Array of IssueListPiFilterInfo objects	参数解释 pi过滤条件约束限制不涉及取值范围不涉及默认取值不涉及
plan_end_date_start	否	String	参数解释计划结束间过滤开始时间点约束限制不涉及取值范围不涉及默认取值不涉及
plan_end_date_end	否	String	参数解释计划结束时间过滤结束时间点约束限制不涉及取值范围不涉及默认取值不涉及

表4 IssueListPiFilterInfo
参数	是否必选	参数类型	描述
sprints	否	Array of strings	参数解释迭代列表约束限制不涉及取值范围不涉及默认取值不涉及
pi_id	否	String	参数解释 pi的id 约束限制不涉及取值范围层级关系：pi -> 迭代 -> 需求默认取值

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
total	Integer	参数解释数据总量约束限制不涉及取值范围起始记录数大于实际总条数时，值为0，分页请求才有此值默认取值不涉及
value	Array of IteratorVersionSummaryVo objects	参数解释请求返回的数据约束限制不涉及取值范围不涉及默认取值不涉及
reason	String	参数解释业务失败的提示内容约束限制不涉及取值范围不涉及默认取值不涉及
page_size	Integer	参数解释每页展示条数约束限制不涉及取值范围不涉及默认取值不涉及
page_no	Integer	参数解释页码约束限制不涉及取值范围不涉及默认取值不涉及
has_more	Boolean	参数解释是否有更多约束限制不涉及取值范围 true:是 false:否默认取值不涉及

表6 IteratorVersionSummaryVo
参数	参数类型	描述
uri	String	参数解释资源uri 取值范围不涉及
type	String	参数解释资源类型取值范围不涉及
author	String	参数解释创建人取值范围不涉及
name	String	参数解释名称取值范围不涉及
rank	Integer	参数解释级别取值范围不涉及
version	String	参数解释待测版本取值范围不涉及
owner	String	参数解释处理者ID 取值范围不涉及
creator	String	参数解释创建人ID 取值范围不涉及
iterations	String	参数解释关联迭代取值范围不涉及
description	String	参数解释描述取值范围不涉及
region	String	参数解释区域取值范围不涉及
last_modifier	String	参数解释最后修改人取值范围不涉及
last_modified	String	参数解释最后修改时间取值范围不涉及
last_modified_timestamp	Long	参数解释修改时间时间戳取值范围不涉及
last_change_time	String	参数解释最后变更时间取值范围不涉及
version_uri	String	参数解释版本URI 取值范围不涉及
origin_uri	String	参数解释源资源URI 取值范围不涉及
parent_uri	String	参数解释父资源URI 取值范围不涉及
parent_path	String	参数解释父资源路径取值范围不涉及
creation_version_uri	String	参数解释创建版本URI 取值范围不涉及
creation_date	String	参数解释创建时间取值范围不涉及
creation_date_timestamp	Long	参数解释创建时间时间戳取值范围不涉及
author_name	String	参数解释创建人名称取值范围不涉及
comment	String	参数解释备注取值范围不涉及
number	String	参数解释编号取值范围不涉及
is_master	Integer	参数解释是否为Master分支取值范围不涉及
is_iterator	Integer	参数解释是否为迭代取值范围不涉及
plan_start_date	String	参数解释开始时间取值范围不涉及
plan_end_date	String	参数解释结束时间取值范围不涉及
service_id	String	参数解释微服务ID 取值范围不涉及
service_name	String	参数解释微服务名取值范围不涉及
pbi_id	String	参数解释 PBI ID 取值范围不涉及
pbi_name	String	参数解释 PBI信息取值范围不涉及
plan_id	String	参数解释计划ID 取值范围不涉及
metric_pbi_ids	String	参数解释度量PBI ID 取值范围不涉及
metric_pbi_id_names	String	参数解释度量PBI名称取值范围不涉及
last_syn_date	String	参数解释最后同步时间取值范围不涉及
is_closed	String	参数解释版本是否关闭取值范围不涉及
asyn_git	String	参数解释是否同步git库取值范围不涉及
schema_no	Integer	参数解释 schema编号取值范围不涉及
finish_date	String	参数解释迭代实际完成时间取值范围不涉及
owner_name	String	参数解释处理者名称取值范围不涉及
creator_name	String	参数解释创建人名称取值范围不涉及
current_stage	String	参数解释当前所处阶段取值范围不涉及
service_types	String	参数解释服务类型取值范围不涉及
risk_rating	Integer	参数解释风险等级取值范围不涉及
risk_des	String	参数解释风险描述取值范围不涉及
project_uuid	String	参数解释项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 取值范围不涉及
domain_id	String	参数解释租户ID 取值范围不涉及
pi_id	String	参数解释 pi的id 取值范围不涉及
start_date	String	参数解释计划开始时间取值范围不涉及
start_date_timestamp	Long	参数解释计划开始时间时间戳取值范围不涉及
end_date	String	参数解释计划结束时间取值范围不涉及
end_date_timestamp	Long	参数解释计划结束时间时间戳取值范围不涉及
actual_start_date	String	参数解释实际开始时间取值范围不涉及
actual_start_date_timestamp	Long	参数解释实际开始时间时间戳取值范围不涉及
actual_end_date	String	参数解释实际完成时间取值范围不涉及
actual_end_date_timestamp	Long	参数解释实际开始时间时间戳取值范围不涉及
is_expired	String	参数解释是否超期取值范围不涉及
expired_info	String	参数解释计划过期信息,空代表不超期，否则给出具体超期信息取值范围不涉及
stages	Array of strings	参数解释迭代计划，默认包含design,execute,report 取值范围不涉及
design	DesignSummaryVo object	参数解释设计总览取值范围不涉及
execute	ExecuteSummaryVo object	参数解释执行情况总览取值范围不涉及
report	ReportSummaryVo object	参数解释报告总览取值范围不涉及
branch_uri	String	参数解释所属分支URI 取值范围不涉及
branch_name	String	参数解释所属分支名称取值范围不涉及

表7 DesignSummaryVo
参数	参数类型	描述
issue_num	Integer	参数解释需求总数取值范围不涉及
issue_cover_num	Integer	参数解释已覆盖需求数取值范围不涉及
case_num	Integer	参数解释用例数取值范围不涉及

表8 ExecuteSummaryVo
参数	参数类型	描述
execute_case_num	Integer	参数解释已执行用例数取值范围不涉及
defect_num	Integer	参数解释缺陷总数取值范围不涉及
completed_defect_num	Integer	参数解释已完成缺陷数取值范围不涉及
case_success_rate	String	参数解释测试用例通过率取值范围不涉及
case_execution_rate	String	参数解释用例执行率取值范围不涉及

表9 ReportSummaryVo
参数	参数类型	描述
case_success_rate	String	参数解释用例通过率取值范围不涉及
case_complete_rate	String	参数解释用例完成率取值范围不涉及

状态码：400

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

状态码：401

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

状态码：404

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

状态码：500

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

请求示例

POST https://{endpoint}/GT3KServer/v4/iterators/batch-query

{
  "project_uuid" : "761e569574894180b3ecadc9d9df52b6",
  "branch_uri" : "v901000106dij34m",
  "name" : "计划1",
  "current_stage" : "",
  "page_no" : 1,
  "page_size" : 10
}

响应示例

状态码：200

{
  "total" : 1,
  "value" : [ {
    "uri" : "v901000107paa4eo",
    "type" : "TestVersion",
    "author" : "85f7cd3cd8784307a5bb194321bef3c1",
    "name" : "计划1",
    "version" : "基线_版本",
    "owner" : "85f7cd3cd8784307a5bb194321bef3c1",
    "creator" : "85f7cd3cd8784307a5bb194321bef3c1",
    "iterations" : "[]",
    "region" : {
      "region" : null
    },
    "last_modifier" : "85f7cd3cd8784307a5bb194321bef3c1",
    "last_modified" : "2025-02-26 10:55:32",
    "last_modified_timestamp" : 1740538532000,
    "last_change_time" : "2025-02-26 10:55:32",
    "version_uri" : "v901000106dij34m",
    "parent_uri" : "v901000106dij34m",
    "parent_path" : "/761e569574894180b3ecadc9d9df52b6/v901000106dij34m/",
    "creation_version_uri" : "v901000106dij34m",
    "creation_date" : "2025-02-07 15:44:59",
    "creation_date_timestamp" : 1738914299000,
    "author_name" : "wtt_apitest",
    "is_master" : 0,
    "is_iterator" : 1,
    "plan_start_date" : "2025-02-07 00:00:00",
    "plan_end_date" : "2025-02-28 23:59:59",
    "service_id" : "761e569574894180b3ecadc9d9df52b6",
    "service_name" : "APITest（勿删）",
    "schema_no" : 9,
    "owner_name" : "wtt_apitest",
    "creator_name" : "wtt_apitest",
    "current_stage" : "execute",
    "service_types" : "[\"0\",\"1\",\"12\",\"7\",\"8\"]",
    "risk_rating" : 0,
    "project_uuid" : "761e569574894180b3ecadc9d9df52b6",
    "pi_id" : "notSelected",
    "start_date" : "2025-02-07",
    "start_date_timestamp" : 1738857600000,
    "end_date" : "2025-02-28",
    "end_date_timestamp" : 1740758399000,
    "actual_start_date" : "2025-02-07",
    "actual_start_date_timestamp" : 1738914359000,
    "is_expired" : "0",
    "expired_info" : "即将超期",
    "stages" : [ "design", "execute", "report" ],
    "design" : {
      "issue_num" : 2,
      "issue_cover_num" : 2,
      "case_num" : 3
    },
    "execute" : {
      "execute_case_num" : 3,
      "defect_num" : 2,
      "completed_defect_num" : 0,
      "case_success_rate" : "66.7%",
      "case_execution_rate" : "100.0%"
    },
    "report" : {
      "case_success_rate" : "66.7%",
      "case_complete_rate" : "66.7%"
    },
    "branch_uri" : "v901000106dij34m",
    "branch_name" : "基线"
  } ],
  "page_size" : 10,
  "page_no" : 1
}

状态码

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

错误码

请参见错误码。

父主题： 测试计划管理

上一篇：查询迭代计划列表，包含统计信息（1.0）

下一篇：查询迭代关联的需求列表或树

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

盘古Doer提问云社区提问