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

质量报告看板统计

功能介绍

质量报告看板统计

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

version_uri

否

String

版本URI

module_id

否

String

模块ID

fixed_version_id

否

String

筛选迭代ID

owner_id

否

String

处理人

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueOverviewVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

对内接口才有此属性
表4 ResultValueOverviewVo

参数

参数类型

描述

total

Integer

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

value

OverviewVo object

当接口对内且status为failed时，存放只有reason的ApiError对象

reason

String

业务失败的提示内容，对内接口才有此值

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表5 OverviewVo

参数

参数类型

描述

defect

DefectVo object

整体缺陷信息

case_pass_rate

CasePassRateVo object

计算用例通过率

case_completion_rate

CaseCompletionRateVo object

计算用例完成率

risk_rating

RiskRatingVo object

测试计划的风险等级和风险描述

project_type

String

项目类型

issue_cover_rate

IssueCoverRateVo object

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

参数

参数类型

描述

total

Integer

缺陷数

not_solved

Integer

未关闭缺陷数

severity_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

pass_rate

String

用例通过率

result_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

total

Integer

总用例数

completion_rate

String

用例完成率

status_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

name

String

名称

value

Integer

值
表10 RiskRatingVo

参数

参数类型

描述

risk_rating

Integer

测试计划的风险等级

risk_description

String

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

参数

参数类型

描述

testing

Integer

统计测试中的需求

finished

Integer

统计已完成的需求

not_tested

Integer

统计未测试的需求

total_number

Integer

计算需求总数

cover_rate

String

需求覆盖率
表13 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表14 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表15 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表16 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表17 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

质量报告看板统计

post https://{endpoint}/v4/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

{
  "status" : "success",
  "result" : {
    "value" : {
      "defect" : {
        "total" : 2,
        "not_solved" : 0,
        "severity_number_list" : [ {
          "name" : "提示",
          "value" : 2
        } ]
      },
      "case_pass_rate" : {
        "pass_rate" : "0.0%",
        "result_number_list" : [ {
          "name" : "成功",
          "value" : 2
        }, {
          "name" : "失败",
          "value" : 2
        }, {
          "name" : "执行中",
          "value" : 3
        }, {
          "name" : "停止",
          "value" : 1
        }, {
          "name" : "未执行",
          "value" : 19994
        } ]
      },
      "project_type" : "ipd",
      "issue_cover_rate" : {
        "epic" : {
          "testing" : 0,
          "finished" : 0,
          "not_tested" : 0,
          "total_number" : 0,
          "cover_rate" : "0.0%"
        },
        "feature" : {
          "testing" : 0,
          "finished" : 0,
          "not_tested" : 0,
          "total_number" : 0,
          "cover_rate" : "0.0%"
        },
        "story" : {
          "testing" : 2,
          "finished" : 0,
          "not_tested" : 4,
          "total_number" : 6,
          "cover_rate" : "0.0%"
        }
      }
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报表管理

相关文档