文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报表管理/ 查询质量报告看板统计信息
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

查询质量报告看板统计信息

功能介绍

查询质量报告看板统计信息

URI

POST /v1/{project_id}/data-dashboard/overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

plan_id

否

String

测试计划id,(plan_id和branch_id不能同时为空，优先取plan_id)

branch_id

否

String

分支id,(plan_id和branch_id不能同时为空，优先取plan_id)

module_id

否

String

模块ID

fixed_version_id

否

String

筛选迭代ID

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

defect

DefectVo object

缺陷统计信息

case_pass_rate

CasePassRateVo object

用例通过率信息

case_completion_rate

CaseCompletionRateVo object

用例通过率信息

project_type

String

项目类型

issue_cover_rate

IssueCoverRateVo object

需求覆盖率信息
表5 DefectVo

参数

参数类型

描述

total

Integer

缺陷数

not_solved

Integer

未关闭缺陷数

severity_number_list

Array of NameAndValueVo objects

组装缺陷每种重要程度的名称和对应的数目
表6 CasePassRateVo

参数

参数类型

描述

pass_rate

String

用例通过率

result_number_list

Array of NameAndValueVo objects

用户自定义结果对应的用例数目
表7 CaseCompletionRateVo

参数

参数类型

描述

total

Integer

总用例数

completion_rate

String

用例完成率

status_number_list

Array of NameAndValueVo objects

用户自定义状态对应的用例数目
表8 NameAndValueVo

参数

参数类型

描述

name

String

名称

value

Integer

值
表9 IssueCoverRateVo

参数

参数类型

描述

epic

CoverRateVo object

epic类型需求覆盖率, 仅scrum项目返回

feature

CoverRateVo object

feature类型需求覆盖率, 仅scrum项目返回

story

CoverRateVo object

story类型需求覆盖率, 仅scrum项目返回

summary

CoverRateVo object

story类型需求覆盖率, 仅scrum项目返回
表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}}/testreport/v4/testhub/projects/875ab809ae454c808b8565bd8695692d/data-dashboard/overview

{
  "plan_id" : "vx785d2300op22kb6c",
  "branch_id" : "v9050000uop22kb6",
  "module_id" : "889109272257798144,-2",
  "fixed_version_id" : "884537509955936256,884770598208577537,-2"
}

响应示例

状态码： 200

OK

{
  "defect" : {
    "total" : 3,
    "not_solved" : 3,
    "severity_number_list" : [ {
      "name" : "提示",
      "value" : 3
    } ]
  },
  "case_pass_rate" : {
    "pass_rate" : "99.5%",
    "result_number_list" : [ {
      "name" : "成功",
      "value" : 3000
    }, {
      "name" : "未执行",
      "value" : 15
    } ]
  },
  "project_type" : "ipd",
  "issue_cover_rate" : {
    "summary" : {
      "testing" : 0,
      "finished" : 0,
      "not_tested" : 17,
      "total_number" : 17,
      "cover_rate" : "0.0%"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报表管理

相关文档