页面报表展示
功能介绍
页面报表展示
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /testreport/v4/{project_id}/versions/{version_id}/custom-reports
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID。 最小长度:32 最大长度:32 |
version_id |
是 |
String |
版本id 最小长度:11 最大长度:34 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_size |
是 |
Long |
每页显示的条目数量,最大支持200条 最小值:1 最大值:200 缺省值:200 |
offset |
是 |
Long |
页数,page_no大于等于1 最小值:0 最大值:20000 缺省值:0 |
type |
是 |
Integer |
报表类型 1:首页用例库, 2:质量报告 最小值:1 最大值:2 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
对外时:success|error; 对内时:ok|failed |
result |
请求的返回的数据对象 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
value |
Array of CustomReportListVo objects |
实际的数据类型:单个对象,集合 或 NULL |
reason |
String |
业务失败的提示内容,对内接口才有此值 |
page_size |
Integer |
每页展示条数 |
page_no |
Integer |
页码 |
has_more |
Boolean |
是否有更多 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
报表数据 |
参数 |
参数类型 |
描述 |
---|---|---|
creatorIds |
String |
创建人 |
ownerIds |
String |
所属人 |
ranks |
String |
级别 |
releaseIds |
String |
releaseId |
status |
String |
状态 |
moduleIds |
String |
级别 |
results |
String |
结果 |
labelIds |
String |
标签 |
startTime |
String |
开始时间 |
endTime |
String |
结束时间 |
isAssociateIssue |
String |
是否关联需求 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
报表id |
name |
String |
报表名称 |
analyze_dim |
ReportDimVo object |
对比维度数据 |
compare_dim |
Array of ReportDimVo objects |
对比维度数据 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
业务失败的错误码 |
reason |
String |
业务失败的提示内容 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。