文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 报告与看板管理/ 质量报告看板统计 - GetReportOverview
更新时间：2026-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

质量报告看板统计 - GetReportOverview

功能介绍

此接口用于质量报告看板统计

调用方法

请参见如何调用API。

URI

POST /v4/projects/{project_id}/report/overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释

项目UUID，项目唯一标识

取值范围

字符串

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

version_uri

是

String

版本URI

module_id

否

String

模块ID

fixed_version_id

否

String

筛选迭代ID

owner_id

否

String

处理人

pi_filter

否

PiFilterInfo object

pi筛选条件

own

否

Boolean

是否是我的
表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

Integer

参数解释

符合条件的所有记录数

取值范围

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

OverviewVo object

status为failed时，存放只有reason的ApiError对象

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

page_size

Integer

参数解释

每页展示条数

取值范围

不涉及

page_no

Integer

参数解释

页码

取值范围

不涉及

has_more

Boolean

参数解释

是否有更多

取值范围

true:是 false:否
表6 OverviewVo

参数

参数类型

描述

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

看板项目的需求覆盖率
表7 DefectVo

参数

参数类型

描述

total

Integer

缺陷数

not_solved

Integer

未关闭缺陷数

severity_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

pass_rate

String

用例通过率

result_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

total

Integer

总用例数

completion_rate

String

用例完成率

status_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

name

String

参数解释

名称，如缺陷重要程度名称或用例执行结果名称

取值范围

不涉及

value

Integer

参数解释

对应名称的数目

取值范围

大于等于0

children

Array of children objects

参数解释

子节点，数组内每个元素包含名称、值和标记值

取值范围

不涉及
表11 children

参数

参数类型

描述

name

String

参数解释

名称

取值范围

不涉及

value

Integer

参数解释

对应名称的数目

取值范围

大于等于0

tag_value

Integer

参数解释

标记值，与value的区别在于标识不同维度的统计数值

取值范围

大于等于0
表12 RiskRatingVo

参数

参数类型

描述

risk_rating

Integer

测试计划的风险等级

risk_description

String

测试计划的风险描述
表13 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)
表14 CoverRateVo

参数

参数类型

描述

testing

Integer

统计测试中的需求

finished

Integer

统计已完成的需求

not_tested

Integer

统计未测试的需求

total_number

Integer

计算需求总数

cover_rate

String

需求覆盖率

状态码：400

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

质量报告看板统计

POST https://{endpoint}/v4/projects/{project_id}/report/overview

{
  "iterator_uris" : [ "iter-001" ]
}

响应示例

状态码：200

{
  "total" : 1,
  "value" : {
    "total_testcases" : 100,
    "passed" : 80,
    "failed" : 15,
    "blocked" : 5
  },
  "reason" : ""
}

状态码：400

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码：500

{
  "error_code" : "CLOUDTEST.00000001",
  "error_msg" : "返回的错误信息"
}

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 报告与看板管理

相关文档