获取进度报表数据 - GetProgressReport
功能介绍
此接口用于获取进度报表数据
调用方法
请参见如何调用API。
URI
GET /v4/{project_uuid}/versions/{version_uri}/progress-reports
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_uuid | 是 | String | 参数解释 项目UUID，项目唯一标识 取值范围 字符串 |
| version_uri | 是 | String | 参数解释 版本URI 取值范围 字符串 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 参数解释 报表类型 1：首页用例库， 2：质量报告 |
| page_no | 否 | Integer | 页码 默认取值： 1 |
| page_size | 否 | Integer | 每页数量 默认取值： 10 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
| value | TestReportListVo object | 请求返回的数据 |
| 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 | 参数解释 发布版本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 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| analyze_dim | ProgressDimData object | 分析维度数据 |
| compare_dim | Array of ProgressDimData objects | 对比维度数据 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 接口调用失败错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
获取进度报表数据
GET https://{endpoint}/v4/{project_uuid}/versions/{version_uri}/progress-reports?type=1&page_no=1&page_size=10
{
"project_uuid" : "098ad17656684cc5a49a4f7007517f95",
"version_uri" : "v82q0001051ancve",
"type" : 1,
"page_no" : 1,
"page_size" : 10
} 响应示例
状态码：200
{
"total" : 1,
"value" : [ {
"report_uri" : "report-001",
"report_name" : "进度报表",
"report_type" : 1,
"created_at" : 1700000000000
} ],
"reason" : "",
"page_size" : 10,
"page_no" : 1,
"has_more" : false
} 状态码：400
{
"error_code" : "CLOUDTEST.00000001",
"error_msg" : "返回的错误信息"
} 状态码：500
{
"error_code" : "CLOUDTEST.00000001",
"error_msg" : "返回的错误信息"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 500 | Internal Server Error |
错误码
请参见错误码。
