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

页面报表展示

功能介绍

页面报表展示

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

version_uri

是

String

版本uri
表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

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

page_no

是

Integer

页码

page_size

是

Integer

每页数量

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

对外时：success|error; 对内时：ok|failed

result

ResultValueListCustomReportListVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

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

参数

参数类型

描述

total

Integer

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

value

Array of CustomReportListVo objects

实际的数据类型：单个对象，集合 或 NULL

reason

String

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

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表5 CustomReportListVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

filter

ReportFilter object

过滤条件

workpiece_type

String

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

analysis_dimension

String

分析维度

compare_dimension

String

对比维度

chart_data

Array of ReportChartDataVo objects

报表数据
表6 ReportFilter

参数

参数类型

描述

creatorIds

String

创建人

ownerIds

String

所属人

ranks

String

级别

releaseIds

String

releaseId

status

String

状态

moduleIds

String

级别

results

String

结果

labelIds

String

标签

startTime

String

开始时间

endTime

String

结束时间

isAssociateIssue

String

是否关联需求
表7 ReportChartDataVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

analyze_dim

ReportDimVo object

分析维度数据

compare_dim

Array of ReportDimVo objects

对比维度数据
表8 ReportDimVo

参数

参数类型

描述

id

String

id

name

String

名称

value

Integer

值
表9 ApiError

参数

参数类型

描述

code

String

响应码

reason

String

业务失败的提示内容

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：404

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

无

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "id" : "2dopbu6aaf",
      "name" : "新建报表"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档