获取进度报表数据
功能介绍
获取进度报表数据:第三方查询增删改资源,返回查表信息(可限定修改时间)
调用方法
请参见如何调用API。
URI
GET /v4/{project_uuid}/versions/{version_uri}/progress-reports
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_uuid |
是 |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
version_uri |
是 |
String |
版本uri |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
报表类型 1:首页用例库, 2:质量报告 |
page_no |
是 |
Integer |
页码 |
page_size |
是 |
Integer |
每页数量 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
success|error |
result |
获取进度报表数据返回体 |
|
error |
ApiError object |
错误信息 |
request_id |
String |
由接口调用方传入,建议使用UUID保证请求的唯一性。 |
server_address |
String |
本次请求的受理的服务地址 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
value |
Array of TestReportListVo objects |
实际的数据类型:单个对象,集合 或 NULL |
reason |
String |
业务失败的提示内容 |
page_size |
Integer |
分页大小 |
page_no |
Integer |
分页编码 |
has_more |
Boolean |
是否有更多 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
报表id |
name |
String |
报表名称 |
type |
Integer |
报表类型 1:首页用例库, 2:质量报告 |
filter |
ReportFilter object |
过滤条件 |
workpiece_type |
String |
工件类型(用例:case,测试套:task) |
daily_chart_data |
Array of ProgressReportData objects |
报表数据 |
all_chart_data |
Array of ProgressReportData objects |
报表数据 |
参数 |
参数类型 |
描述 |
---|---|---|
creatorIds |
String |
创建人 |
ownerIds |
String |
所属人 |
ranks |
String |
级别 |
releaseIds |
String |
releaseId |
status |
String |
状态 |
moduleIds |
String |
级别 |
results |
String |
结果 |
labelIds |
String |
标签 |
startTime |
String |
开始时间 |
endTime |
String |
结束时间 |
isAssociateIssue |
String |
是否关联需求 |
参数 |
参数类型 |
描述 |
---|---|---|
analyze_dim |
ProgressDimData object |
分析维度数据 |
compare_dim |
Array of ProgressDimData objects |
对比维度数据 |
状态码: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 |
接口调用失败错误信息 |
请求示例
get https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/versions/12sd3123sp/progress-reports?type=1&page_no=1&page_size=10
响应示例
状态码:200
获取进度报表数据返回体
{ "status" : "ok", "result" : { "value" : [ { "id" : "112", "name" : "自定义报表", "type" : 1 } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
获取进度报表数据返回体 |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。