更新时间:2024-11-19 GMT+08:00
分享

页面报表展示

功能介绍

页面报表展示

URI

GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目id,对应"需求管理 CodeArts Req"项目唯一标识,测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

version_id

String

版本id

表2 Query参数

参数

是否必选

参数类型

描述

page_size

Long

每页显示的条目数量,最大支持200条

offset

Long

页数,page_no大于等于1

type

Integer

报表类型 1:首页用例库, 2:质量报告

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListCustomReportListVo object

请求的返回的数据对象

表5 ResultValueListCustomReportListVo

参数

参数类型

描述

total

Integer

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

value

Array of CustomReportListVo objects

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

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表6 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

报表数据

表7 ReportFilter

参数

参数类型

描述

creatorIds

String

创建人

ownerIds

String

所属人

ranks

String

级别

releaseIds

String

releaseId

status

String

状态

moduleIds

String

级别

results

String

结果

labelIds

String

标签

startTime

String

开始时间

endTime

String

结束时间

isAssociateIssue

String

是否关联需求

表8 ReportChartDataVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

analyze_dim

ReportDimVo object

对比维度数据

compare_dim

Array of ReportDimVo objects

对比维度数据

表9 ReportDimVo

参数

参数类型

描述

id

String

id

name

String

名称

value

Integer

状态码: 400

表10 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 401

表11 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 404

表12 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码: 500

表13 响应Body参数

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

请求示例

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档