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

页面报表展示 - GetCustomReports

功能介绍

此接口用于页面报表展示

调用方法

请参见如何调用API。

URI

GET /v4/{project_uuid}/versions/{version_uri}/custom-reports

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

是

String

参数解释

项目UUID，项目唯一标识

取值范围

字符串

version_uri

是

String

参数解释

版本URI

取值范围

字符串
表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释

报表类型 1：首页用例库， 2：质量报告

page_no

否

Integer

页码

默认取值：

1

page_size

否

Integer

每页数量

默认取值：

10

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

符合条件的所有记录数

value

Array of CustomReportListVo objects

自定义报表列表

reason

String

错误信息

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表4 CustomReportListVo

参数

参数类型

描述

id

String

报表ID

name

String

报表名称

workpiece_type

String

工件类型(用例:case,测试套:task)

analysis_dimension

String

分析维度

compare_dimension

String

对比维度

chart_data

Array of ReportChartDataVo objects

报表图表数据

filter

ReportFilter object

过滤条件
表5 ReportChartDataVo

参数

参数类型

描述

id

String

参数解释

报表id

取值范围

不涉及

name

String

参数解释

报表名称

取值范围

不涉及

analyze_dim

ReportDimVo object

参数解释

分析维度数据

取值范围

不涉及

compare_dim

Array of ReportDimVo objects

参数解释

对比维度数据

取值范围

不涉及
表6 ReportDimVo

参数

参数类型

描述

id

String

参数解释

id

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及

value

Integer

参数解释

值

取值范围

不涉及
表7 ReportFilter

参数

参数类型

描述

version_uri

String

版本URI

iterator_uri

String

迭代URI

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

页面报表展示

GET https://{endpoint}/v4/{project_uuid}/versions/{version_uri}/custom-reports?type=1&page_no=1&page_size=10

{
  "project_uuid" : "098ad17656684cc5a49a4f7007517f95",
  "version_uri" : "v82q0001051ancve",
  "type" : 1,
  "page_no" : 1,
  "page_size" : 10
}

响应示例

状态码：200

OK

{
  "total" : 1,
  "value" : [ {
    "report_uri" : "report-001",
    "report_name" : "自定义报表",
    "report_type" : 1
  } ],
  "reason" : "",
  "page_size" : 10,
  "page_no" : 1,
  "has_more" : false
}

状态码：400

Bad Request

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

状态码：500

Internal Server Error

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

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 报告与看板管理

相关文档