接口质量报告看板统计 - ShowProjectDefects

功能介绍

接口质量报告看板统计

调用方法

URI

POST /v4/testhub/projects/{project_id}/data-dashboard/overview

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
plan_id	否	String	测试计划id
branch_id	是	String	分支id
module_id	否	String	模块ID
fixed_version_id	否	String	筛选迭代ID
owner_id	否	String	处理人

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
defect	DefectVo object	整体缺陷信息
case_pass_rate	CasePassRateVo object	计算用例通过率
case_completion_rate	CaseCompletionRateVo object	计算用例完成率
risk_rating	RiskRatingVo object	测试计划的风险等级和风险描述
project_type	String	参数解释: 项目类型取值范围: normal，普通项目。 scrum，scrum项目。 xboard，xboard项目。 ipd，ipd项目。默认取值: 不涉及
issue_cover_rate	IssueCoverRateVo object	看板项目的需求覆盖率

表4 DefectVo
参数	参数类型	描述
total	Integer	缺陷数
not_solved	Integer	未关闭缺陷数
severity_number_list	Array of NameAndValueVo objects	组装缺陷每种重要程度的名称和对应的数目

表5 CasePassRateVo
参数	参数类型	描述
pass_rate	String	用例通过率
result_number_list	Array of NameAndValueVo objects	用户自定义结果对应的用例数目

表6 CaseCompletionRateVo
参数	参数类型	描述
total	Integer	总用例数
completion_rate	String	用例完成率
status_number_list	Array of NameAndValueVo objects	用户自定义状态对应的用例数目

表7 NameAndValueVo
参数	参数类型	描述
name	String	参数解释名称取值范围不涉及
value	Integer	参数解释值取值范围不涉及

表8 RiskRatingVo
参数	参数类型	描述
risk_rating	Integer	测试计划的风险等级
risk_description	String	测试计划的风险描述

表9 IssueCoverRateVo
参数	参数类型	描述
epic	CoverRateVo object	epic类型需求覆盖率, 仅scrum项目返回
feature	CoverRateVo object	feature类型需求覆盖率, 仅scrum项目返回
story	CoverRateVo object	story类型需求覆盖率, 仅scrum项目返回
summary	CoverRateVo object	需求覆盖率(scrum项目仅返回epic、feature、story。非scrum项目仅返回summary)

**表10** CoverRateVo
参数	参数类型	描述
testing	Integer	统计测试中的需求
finished	Integer	统计已完成的需求
not_tested	Integer	统计未测试的需求
total_number	Integer	计算需求总数
cover_rate	String	需求覆盖率

状态码：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/testhub/projects/2e8b14eb90d54b6c9bc4c0b5cde1f449/data-dashboard/overview

{
  "plan_id" : "0001719bab7a4b1fba9bc2631ad1fe7b",
  "branch_id" : "60ace553eaf7c955f8cf1615",
  "module_id" : "60ace553eaf7c955f8cf1615",
  "fixed_version_id" : "0001719bab7a4b1fba9bc2631ad1fe7b,0000b05bc97c47b1a84ad18106ee7b3c",
  "owner_id" : "zhaoxu001"
}

响应示例

状态码：200

{
  "defect" : {
    "total" : 1,
    "not_solved" : 1,
    "severity_number_list" : [ {
      "name" : "提示",
      "value" : 1,
      "children" : [ {
        "name" : "分析",
        "value" : 1,
        "tag_value" : 1
      } ]
    } ]
  },
  "case_pass_rate" : {
    "pass_rate" : "30.0%",
    "result_number_list" : [ {
      "name" : "成功",
      "value" : 9048
    }, {
      "name" : "失败",
      "value" : 919
    }, {
      "name" : "阻塞",
      "value" : 30
    }, {
      "name" : "未执行",
      "value" : 20079
    } ]
  },
  "project_type" : "ipd",
  "issue_cover_rate" : {
    "summary" : {
      "testing" : 0,
      "finished" : 1,
      "not_tested" : 0,
      "total_number" : 1,
      "cover_rate" : "100.0%"
    }
  }
}