更新时间:2025-07-24 GMT+08:00
分享

质量报告按服务类型统计

功能介绍

质量报告按服务类型统计

调用方法

请参见如何调用API

URI

POST /v4/projects/{project_id}/service-types/overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表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参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListTestTypeOverviewVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

本次请求的受理的服务地址

表6 ResultValueListTestTypeOverviewVo

参数

参数类型

描述

total

Integer

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

value

Array of TestTypeOverviewVo objects

实际的数据类型:单个对象,集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表7 TestTypeOverviewVo

参数

参数类型

描述

service_type

String

当前已经注册的用例类型,按照从小到大排序

issue_cover_rate

String

需求覆盖率

case_pass_rate

String

用例通过率

case_completion_rate

String

用例完成率

defect_number

Integer

缺陷数

表8 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

质量报告按服务类型统计

post https://{endpoint}/v4/projects/26927372bbae40b184fe764e7a0d21f7/service-types/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" : [ {
      "service_type" : "0",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "1",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "6",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "7",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "8",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "11",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "32",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 0
    }, {
      "service_type" : "14352",
      "issue_cover_rate" : "0.0%",
      "case_pass_rate" : "0.0%",
      "defect_number" : 2
    } ]
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档