# 质量报告看板统计 - ShowOverviewInfo #### 功能介绍 此接口用于查看质量看板,同页面 测试 -\> 测试质量看板 -\> 右侧质量看板统计信息 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v5/projects/{project_id}/report/overview 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) | #### 请求参数 表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 | 是否是我的 | 表3PiFilterInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | pi_sprints | 否 | Array of [PiInfo] objects | **参数解释** pi迭代筛选条件 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | all_pi | 否 | Boolean | **参数解释** pi下拉框全选标识 **约束限制** 不涉及 **取值范围** 全选时为true **默认取值** 不涉及 | 表4PiInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | sprints | 否 | Array of strings | **参数解释** 迭代列表 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | pi_id | 否 | String | **参数解释** pi的id **约束限制** 不涉及 **取值范围** 层级关系：pi -\> 迭代 -\> 需求 **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | is_async_operate | Boolean | 是否异步.固定为true:需要在调异步进度接口(/v4/testhub/progress/{operation_uri})获取此次请求的最终处理结果 | | async_uri | String | 异步进度uri,需要在调异步进度接口(/v4/testhub/progress/{operation_uri}获取此次请求的最终处理结果 | | return_value | [OverviewVo] object | 请求返回的数据,需要调用异步解读接口(/v4/testhub/progress/{operation_uri})获取此次请求的最终处理结果 | 表6OverviewVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 看板项目的需求覆盖率 | 表7DefectVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 缺陷数 | | not_solved | Integer | 未关闭缺陷数 | | severity_number_list | Array of [NameAndValueVo] objects | 组装缺陷每种重要程度的名称和对应的数目 | 表8CasePassRateVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pass_rate | String | 用例通过率 | | result_number_list | Array of [NameAndValueVo] objects | 用户自定义结果对应的用例数目 | 表9CaseCompletionRateVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | 总用例数 | | completion_rate | String | 用例完成率 | | status_number_list | Array of [NameAndValueVo] objects | 用户自定义状态对应的用例数目 | 表10NameAndValueVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释** 名称 **取值范围** 不涉及 | | value | Integer | **参数解释** 值 **取值范围** 无 | | children | Array of [children] objects | 子节点 | 表11children | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 名称 | | value | Integer | 值 | | tag_value | Integer | 标记值，补充字段，区分与value | 表12RiskRatingVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | risk_rating | Integer | 测试计划的风险等级 | | risk_description | String | 测试计划的风险描述 | 表13IssueCoverRateVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | epic | [CoverRateVo] object | epic类型需求覆盖率, 仅scrum项目返回 | | feature | [CoverRateVo] object | feature类型需求覆盖率, 仅scrum项目返回 | | story | [CoverRateVo] object | story类型需求覆盖率, 仅scrum项目返回 | | summary | [CoverRateVo] object | 需求覆盖率(scrum项目仅返回epic、feature、story。非scrum项目仅返回summary) | 表14CoverRateVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | testing | Integer | 统计测试中的需求 | | finished | Integer | 统计已完成的需求 | | not_tested | Integer | 统计未测试的需求 | | total_number | Integer | 计算需求总数 | | cover_rate | String | 需求覆盖率 | **状态码：400** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：401** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：404** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：500** 表18响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | #### 请求示例 质量报告看板统计 ``` post https://{endpoint}/v5/projects/26927372bbae40b184fe764e7a0d21f7/report/overview { "version_uri" : "v91k0000vgtfg1jk", "module_id" : "994928222970748929,994928245960912896,994928263572795393,994928294128300032,994928330747584512,-2", "pi_filter" : { "all_pi" : true, "pi_sprints" : [ { "pi_id" : "1035314883144495104", "sprints" : [ "" ] }, { "pi_id" : "991653518035169281", "sprints" : [ "991653560740388864", "" ] }, { "pi_id" : "", "sprints" : [ "" ] } ] } } ``` #### 响应示例 **状态码：200** OK ``` { "is_async_operate" : true, "async_uri" : "0c897311d2884e0fa68c2ab7ac88674dv93600010u9q98br" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。