页面报表展示 - ListReportsFour
功能介绍
此接口用于测试质量看板下的页面报表展示
调用方法
请参见如何调用API。
URI
GET /v4/{project_id}/versions/{version_uri}/custom-reports
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
| version_uri | 是 | String | 版本uri |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 报表类型 1：首页用例库， 2：质量报告 |
| page_no | 是 | Integer | 页码 |
| page_size | 是 | Integer | 每页数量，最大为5 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 取值范围: 记录数>=0 |
| value | Array of CustomReportListVo objects | 参数解释: 实际的数据类型：单个对象，集合 或 NULL 取值范围: 记录数>=0 |
| reason | String | 参数解释 业务失败的提示内容 取值范围 不涉及 |
| page_size | Integer | 参数解释 每页展示条数 取值范围 不涉及 |
| page_no | Integer | 参数解释 页码 取值范围 不涉及 |
| has_more | Boolean | 参数解释 是否有更多 取值范围 true:是 false:否 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 报表id 取值范围: 不涉及 |
| name | String | 参数解释: 报表名称 取值范围: 不涉及 |
| filter | ReportFilter object | 参数解释 过滤信息 取值范围 不涉及 |
| workpiece_type | String | 参数解释 工件类型 取值范围 |
| analysis_dimension | String | 参数解释 分析维度 取值范围 不涉及 |
| compare_dimension | String | 参数解释 对比维度 取值范围 不涉及 |
| chart_data | Array of ReportChartDataVo objects | 参数解释 报表数据，数组内每个ReportChartDataVo对象包含报表ID、报表名称、分析维度数据等 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| creatorIds | String | 参数解释 创建人 取值范围 不涉及 |
| ownerIds | String | 参数解释 所属人 取值范围 不涉及 |
| ranks | String | 参数解释 级别 取值范围 不涉及 |
| releaseIds | String | 参数解释 发布版本ID 取值范围 不涉及 |
| status | String | 参数解释: 状态 取值范围: |
| 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 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释 报表id 取值范围 不涉及 |
| name | String | 参数解释 报表名称 取值范围 不涉及 |
| analyze_dim | ReportDimVo object | 参数解释 分析维度数据，ReportDimVo对象包含ID、名称和值 取值范围 不涉及 |
| compare_dim | Array of ReportDimVo objects | 参数解释 对比维度数据，数组内每个ReportDimVo对象包含ID、名称和值 取值范围 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释 id 取值范围 不涉及 |
| name | String | 参数解释 名称 取值范围 不涉及 |
| value | Integer | 参数解释 值 取值范围 不涉及 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
无
响应示例
状态码：200
{
"total" : 1,
"value" : [ {
"id" : "v90100010q1uge6m",
"name" : "1111111",
"filter" : {
"status" : [ "7" ]
},
"workpiece_type" : "case",
"analysis_dimension" : "name",
"compare_dimension" : "name",
"chart_data" : [ ]
} ],
"page_size" : 5,
"page_no" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。
