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

V5页面报表展示 异步 - V5AsyncGetReportList

功能介绍

此接口用于V5版本页面报表展示，支持异步查询

调用方法

请参见如何调用API。

URI

GET /v5/{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

参数解释

页码

默认取值

1

默认取值：

1

page_size

否

Integer

参数解释

每页数量

取值范围

1-200

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

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

取值范围:

大于等于0的整数

value

CustomReportListVo object

参数解释

返回值

取值范围

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

page_size

Integer

参数解释:

每页展示条数

取值范围:

大于等于0的整数

page_no

Integer

参数解释:

页码

取值范围:

不涉及

has_more

Boolean

参数解释:

是否有更多

确实范围:

true|false
表4 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

参数解释

报表数据，数组内每个ReportChartDataVo对象包含报表ID、报表名称、分析维度数据等

取值范围

不涉及
表5 ReportFilter

参数

参数类型

描述

creatorIds

String

参数解释

创建人

取值范围

不涉及

ownerIds

String

参数解释

所属人

取值范围

不涉及

ranks

String

参数解释

级别

取值范围

不涉及

releaseIds

String

参数解释

发布版本ID

取值范围

不涉及

status

String

参数解释:

状态

取值范围:

  • -1，删除。

  • 0，新建。

  • 5，设计中。

  • 6，测试中。

  • 7，完成。

  • -2，未设置。

moduleIds

String

参数解释

模块ID

取值范围

不涉及

results

String

参数解释

结果

取值范围

不涉及

labelIds

String

参数解释

标签

取值范围

不涉及

startTime

String

参数解释

开始时间，UTC时间格式yyyy-MM-dd HH:mm:ss

取值范围

不涉及

endTime

String

参数解释

结束时间，UTC时间格式yyyy-MM-dd HH:mm:ss

取值范围

不涉及

isAssociateIssue

String

参数解释

是否关联需求

取值范围

不涉及

featureUris

String

参数解释

目录uris

取值范围

数组元素个数不超过1000
表6 ReportChartDataVo

参数

参数类型

描述

id

String

参数解释

报表id

取值范围

不涉及

name

String

参数解释

报表名称

取值范围

不涉及

analyze_dim

ReportDimVo object

参数解释

分析维度数据，ReportDimVo对象包含ID、名称和值

取值范围

不涉及

compare_dim

Array of ReportDimVo objects

参数解释

对比维度数据，数组内每个ReportDimVo对象包含ID、名称和值

取值范围

不涉及
表7 ReportDimVo

参数

参数类型

描述

id

String

参数解释

id

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及

value

Integer

参数解释

值

取值范围

不涉及

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

V5页面报表展示

GET https://{endpoint}/v5/{project_id}/versions/{version_uri}/custom-reports?type=1&page_no=1&page_size=20

{
  "project_id" : "098ad17656684cc5a49a4f7007517f95",
  "version_uri" : "version-001",
  "type" : "1",
  "page_no" : 1,
  "page_size" : 20
}

响应示例

状态码：200

{
  "total" : 2,
  "value" : [ {
    "id" : "report-001",
    "name" : "首页用例统计",
    "workpiece_type" : "1",
    "analysis_dimension" : "BaseLine",
    "compare_dimension" : "BaseLine",
    "chart_data" : [ {
      "id" : "1",
      "name" : "报表名称",
      "analyze_dim" : {
        "id" : "1",
        "name" : "名称",
        "value" : 0
      },
      "compare_dim" : [ {
        "id" : "1",
        "name" : "名称",
        "value" : 0
      } ]
    } ],
    "filter" : {
      "version_uri" : "vgqi0001095m",
      "iterator_uri" : "vgqi00011fj5m"
    }
  } ],
  "reason" : "",
  "page_size" : 10,
  "page_no" : 1,
  "has_more" : true
}

状态码：400

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

状态码：500

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

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 报告与看板管理

相关文档