文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报表管理/ 测试计划首页看板统计
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

测试计划首页看板统计

功能介绍

测试计划首页看板统计

调用方法

请参见如何调用API。

URI

POST /v4/projects/{project_id}/home/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

ResultValueHomePageOverviewVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

本次请求的受理的服务地址。
表6 ResultValueHomePageOverviewVo

参数

参数类型

描述

total

Integer

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

value

HomePageOverviewVo object

请求返回的数据

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表7 HomePageOverviewVo

参数

参数类型

描述

case_completion_rate

CaseCompletionRateVo object

计算用例完成率

case_pass_rate

CasePassRateVo object

计算用例通过率

defect_status

DefectStatusVo object

统计缺陷信息，组装缺陷状态分组信息

defect_severity

DefectSeverityVo object

统计缺陷信息，组装缺陷重要程度分组信息
表8 CaseCompletionRateVo

参数

参数类型

描述

total

Integer

总用例数

completion_rate

String

用例完成率

status_number_list

Array of NameAndValueVo objects

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

参数

参数类型

描述

pass_rate

String

用例通过率

result_number_list

Array of NameAndValueVo objects

用户自定义结果对应的用例数目
表10 DefectStatusVo

参数

参数类型

描述

total

Integer

缺陷数

not_solved

Integer

未关闭缺陷数

status_number_list

Array of NameAndValueVo objects

每种状态的名称和对应的数目
表11 DefectSeverityVo

参数

参数类型

描述

total

Integer

缺陷数

severity_number_list

Array of NameAndValueVo objects

每种重要程度的名称和对应的数目
表12 NameAndValueVo

参数

参数类型

描述

name

String

参数解释

名称

取值范围

不涉及

value

Integer

参数解释

值

取值范围

不涉及
表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/3d2378e0fc504c638f48b21377d6add1/home/overview

{
  "owner_id" : "efdb403066474ab08836b9eeaaa23bca",
  "version_uri" : "v91i0000vrpquiv5"
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "case_completion_rate" : {
        "total" : 123,
        "completion_rate" : "12%"
      }
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报表管理

相关文档