页面报表展示 - ListReportsFour

功能介绍

此接口用于测试质量看板下的页面报表展示

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/versions/{version_uri}/custom-reports

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID
version_uri	是	String	版本uri

表2 Query参数
参数	是否必选	参数类型	描述
type	是	String	报表类型 1：首页用例库， 2：质量报告
page_no	是	Integer	页码
page_size	是	Integer	每页数量，最大为5

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
total	Integer	起始记录数大于实际总条数时，值为0，分页请求才有此值
value	Array of CustomReportListVo objects	实际的数据类型：单个对象，集合或 NULL
reason	String	业务失败的提示内容，对内接口才有此值
page_size	Integer	分页大小
page_no	Integer	分页编码
has_more	Boolean	是否有更多

表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	报表数据

表5 ReportFilter
参数	参数类型	描述
creatorIds	String	创建人
ownerIds	String	所属人
ranks	String	级别
releaseIds	String	releaseId
status	String	参数解释: 状态取值范围: -1，删除。 0，新建。 5，设计中。 6，测试中。 7，完成。 -2，未设置。
moduleIds	String	级别
results	String	结果
labelIds	String	标签
startTime	String	开始时间
endTime	String	结束时间
isAssociateIssue	String	是否关联需求

表6 ReportChartDataVo
参数	参数类型	描述
id	String	报表id
name	String	报表名称
analyze_dim	ReportDimVo object	分析维度数据
compare_dim	Array of ReportDimVo objects	对比维度数据

表7 ReportDimVo
参数	参数类型	描述
id	String	id
name	String	名称
value	Integer	值

状态码：400

表8 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：401

表9 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：404

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	接口调用失败错误码
error_msg	String	接口调用失败错误信息

请求示例

无

响应示例

状态码：200

{
  "total" : 1,
  "value" : [ {
    "id" : "v90100010q1uge6m",
    "name" : "1111111",
    "filter" : {
      "featureUris" : [ "123" ]
    },
    "workpiece_type" : "case",
    "analysis_dimension" : "name",
    "compare_dimension" : "name",
    "chart_data" : [ ]
  } ],
  "page_size" : 5,
  "page_no" : 1
}