测试计划 CODEARTS TESTPLAN-实时计算单个自定义报表:响应参数

时间:2024-08-06 19:32:26

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueCustomReportListVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

表6 ResultValueCustomReportListVo

参数

参数类型

描述

total

Integer

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

value

CustomReportListVo object

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

reason

String

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

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

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

报表数据

表8 ReportFilter

参数

参数类型

描述

creatorIds

String

参数解释:

自定义报表创建人用户ID,指定由对应用户创建的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个用户ID,用逗号拼接

默认取值:

不涉及

ownerIds

String

参数解释:

自定义报表所属人用户ID,指定由对应用户作为Owner的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个用户ID,用逗号拼接

默认取值:

不涉及

ranks

String

参数解释:

测试用例级别,指定对应用例级别的用例进行报表生成

约束限制:

不涉及

取值范围:

级别为数字, 可选择多个用例级别,用逗号拼接

默认取值:

不涉及

releaseIds

String

参数解释:

需求管理中迭代计划的ID,指定关联了对应迭代的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个迭代ID,用逗号拼接

默认取值:

不涉及

status

String

参数解释:

测试用例状态ID, 指定对应用例状态下的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符(数字),可选择多个状态ID,用逗号拼接

默认取值:

不涉及

moduleIds

String

参数解释:

需求管理中定义的模块ID,指定关联了对应模块的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个模块,用逗号拼接

默认取值:

不涉及

results

String

参数解释:

测试用例结果的状态编码,指定对应用例结果的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符(数字),可选择多个结果ID,用逗号拼接

默认取值:

不涉及

labelIds

String

参数解释:

测试用例关联的标签ID,指定对应关联了该标签的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符(字母或数字),可选择多个标签,用逗号拼接

默认取值:

不涉及

startTime

String

参数解释:

开始时间,指定创建时间在该时间之后的用例进行报表生成

约束限制:

与结束时间配合,过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss,如:2020-09-08 10:42:07

默认取值:

不涉及

endTime

String

参数解释:

结束时间,指定创建时间在该时间之前的用例进行报表生成

约束限制:

与开始时间配合,过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss,如:2020-09-08 10:42:07

默认取值:

不涉及

isAssociateIssue

String

参数解释:

是否关联需求,指定已关联需求或未关联需求的用例进行报表生成

约束限制:

不涉及

取值范围:

true或false

默认取值:

不涉及

表9 ReportChartDataVo

参数

参数类型

描述

id

String

报表id

name

String

报表名称

analyze_dim

ReportDimVo object

对比维度数据

compare_dim

Array of ReportDimVo objects

对比维度数据

表10 ReportDimVo

参数

参数类型

描述

id

String

id

name

String

名称

value

Integer

表11 ApiError

参数

参数类型

描述

code

String

只有对外的接口才会返回此内容

reason

String

业务失败的提示内容

状态码: 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码: 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

support.huaweicloud.com/api-testman/ShowReport.html