页面报表展示 - ListReportsv4

功能介绍

此接口用于页面报表展示,同页面测试 -> 测试质量看板 -> 右侧看板展示下划 -> 自定义测试报表/自定义分布报表/进度报表

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目UUID，项目唯一标识。获取方式请参见获取项目ID 约束限制: 不涉及取值范围: 长度等于32位，包含大小写字母、数字默认取值: 不涉及
version_id	是	String	参数解释版本id 约束限制不涉及取值范围不涉及获取方法：从GET /v4/projects/{project_id}/iterator-infos的返回字段获取从GET /v1/{project_id}/branches 的返回字段获取默认取值不涉及

表2 Query参数
参数	是否必选	参数类型	描述
type	是	String	参数解释报表类型 1：首页用例库， 2：质量报告
page_no	否	Integer	页码默认取值： 1
page_size	否	Integer	每页数量默认取值： 10

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
value	Array of CustomReportListVo objects	页面报表展示返回参数

表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	参数解释: 接口调用失败错误信息取值范围: 不涉及

请求示例

获取进度报表数据

GET https://{endpoint}/testreport/v4/{project_id}/versions/{version_id}/custom-reports?type=1&page_no=1&page_size=10

{
  "project_uuid" : "098ad17656684cc5a49a4f7007517f95",
  "version_uri" : "v82q0001051ancve",
  "type" : 1,
  "page_no" : 1,
  "page_size" : 10
}

响应示例

状态码：200

{
  "value" : [ {
    "id" : "string",
    "name" : "string",
    "workpiece_type" : "string",
    "analysis_dimension" : "string",
    "compare_dimension" : "string",
    "chart_data" : [ {
      "id" : "1",
      "name" : "报表名称",
      "analyze_dim" : {
        "id" : "1",
        "name" : "名称",
        "value" : 0
      },
      "compare_dim" : [ {
        "id" : "1",
        "name" : "名称",
        "value" : 0
      } ]
    } ],
    "filter" : {
      "version_uri" : "string",
      "iterator_uri" : "string"
    }
  } ]
}

状态码：400

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

状态码：500

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

状态码

状态码	描述
200	OK
400	Bad Request
500	Internal Server Error

错误码

请参见错误码。

父主题： 报告与看板管理

上一篇：查询测试中心ETL最大行数 - QueryTesthubEtlMaxRowSize

下一篇：查询用户ETL数据列表 - QueryUserEtlDataList