质量报告需求测试情况统计 - 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	过滤项

表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
参数	参数类型	描述
workitemId	String	需求id
sequenceId	String	需求序列编号
boardId	String	看板需求id
name	String	需求名称
trackerId	String	需求类型id
trackerName	String	需求类型
relateCaseNumber	Integer	需求关联用例总数
casePassVo	Object	需求关联用例通过情况
caseExecuteVo	Object	需求关联用例执行率情况
relateDefectNumber	Integer	需求关联缺陷总数
status	Object	参数解释: 需求状态取值范围: IPD项目 13，初始。 1，分析。 6，开发。 12，研发。 15 测试。 8 完成。 1，新建。 2，进行中。 3，已解决。 4，测试中。 5 已关闭。 6 已拒绝。 Scrum项目 Xboard项目使用status_name字段记录状态的中文
statusName	Object	状态名

状态码：400

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

状态码：401

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

状态码：404

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

状态码：500

**表10** 响应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" : { }
  } ]
}