文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报表管理/ 质量报告需求测试情况统计 - ShowRequirementsOverviewFour

更新时间：2026-10-22 GMT+08:00

查看PDF

质量报告需求测试情况统计 - ShowRequirementsOverviewFour

功能介绍

此接口用于查询质量报告需求测试情况统计,同页面测试 -> 测试质量看板 -> 右侧需求测试情况页签

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/versions/{version_uri}/requirements/overview

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
fixed_version_id	否	String	参数解释筛选迭代ID 约束限制不涉及取值范围不涉及默认取值不涉及
module_id	否	String	参数解释模块ID 约束限制不涉及取值范围不涉及默认取值不涉及
key_word	否	String	参数解释关键字约束限制不涉及取值范围不涉及默认取值不涉及
page_size	否	Integer	参数解释每页数量约束限制不涉及取值范围不涉及默认取值不涉及
page_no	否	Integer	参数解释页码约束限制不涉及取值范围不涉及默认取值不涉及
pi_filter	否	PiFilterInfo object	参数解释 pi过滤条件约束限制不涉及取值范围不涉及默认取值不涉及

表3 PiFilterInfo
参数	是否必选	参数类型	描述
pi_sprints	否	Array of PiInfo objects	参数解释 pi迭代筛选条件约束限制不涉及取值范围不涉及默认取值不涉及
all_pi	否	Boolean	参数解释 pi下拉框全选标识约束限制不涉及取值范围全选时为true 默认取值不涉及

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

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
total_number	Integer	参数解释质量报告需求测试情况总数取值范围不涉及
requirement_overview_list	Array of RequirementOverviewVo objects	参数解释质量报告需求测试情况列表取值范围不涉及

表6 RequirementOverviewVo
参数	参数类型	描述
name	String	参数解释需求名称取值范围不涉及
workitem_id	String	参数解释需求id 取值范围不涉及
sequence_id	String	参数解释需求序列编号取值范围不涉及
board_id	String	参数解释看板需求id 取值范围不涉及
tracker_id	String	参数解释需求类型id 取值范围不涉及
tracker_name	String	参数解释需求类型取值范围不涉及
relate_case_number	Integer	参数解释需求关联用例总数取值范围不涉及
case_pass_vo	CasePassVo object	参数解释用例通过信息取值范围不涉及
case_execute_vo	CaseExecuteVo object	参数解释用例执行信息取值范围不涉及
relate_defect_number	Integer	参数解释需求关联缺陷总数取值范围不涉及

表7 CasePassVo
参数	参数类型	描述
pass_rate	String	参数解释需求关联用例通过率取值范围不涉及
result_number_list	Array of NameAndValueVo objects	参数解释需求关联用例结果与对应的用例数目列表取值范围不涉及

表8 NameAndValueVo
参数	参数类型	描述
name	String	参数解释名称，如缺陷重要程度名称或用例执行结果名称取值范围不涉及
value	Integer	参数解释对应名称的数目取值范围大于等于0
children	Array of children objects	参数解释子节点，数组内每个元素包含名称、值和标记值取值范围不涉及

表9 children
参数	参数类型	描述
name	String	参数解释名称取值范围不涉及
value	Integer	参数解释对应名称的数目取值范围大于等于0
tag_value	Integer	参数解释标记值，与value的区别在于标识不同维度的统计数值取值范围大于等于0

**表10** CaseExecuteVo
参数	参数类型	描述
execute_rate	String	参数解释需求关联用例执行率取值范围不涉及
executed_number	Integer	参数解释需求关联已执行用例总数取值范围不涉及
not_executed_number	Integer	参数解释需求关联未执行用例总数取值范围不涉及

状态码：400

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

状态码：401

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

状态码：404

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

状态码：500

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

请求示例

post https://{endpoint}/v4/a5eb0d410ea341a192f7c12483568985/versions/v90100010gpop318/requirements/overview?_=1750314218513

{
  "key_word" : "",
  "page_size" : 5,
  "page_no" : 1,
  "fixed_version_id" : "-2"
}

响应示例

状态码：200

{
  "total_number" : 0,
  "requirement_overview_list" : [ {
    "workitemId" : "string",
    "sequenceId" : "string",
    "boardId" : "string",
    "name" : "string",
    "trackerId" : "string",
    "trackerName" : "string",
    "relateCaseNumber" : 0,
    "casePassVo" : { },
    "caseExecuteVo" : { },
    "relateDefectNumber" : 0,
    "status" : { },
    "statusName" : { }
  } ]
}

状态码

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

错误码

请参见错误码。

父主题： 测试报表管理

上一篇：页面报表展示 - ListReports

下一篇：质量报告需求测试情况用例详情 - ListRequirementsOverviewTestCase