# 实时获取进度报表数据 - RefreshProgressReport #### 功能介绍 此接口用于实时获取进度报表数据,同页面 测试 -\> 测试质量看板 -\> 进度报表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v4/{project_uuid}/versions/{version_uri}/progress-reports/refresh 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_uuid | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) | | version_uri | 是 | String | 分支/计划uri | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 报表名称 | | workpiece_type | 否 | String | 工件类型(用例：case,测试套：suite) | | analysis_dim_row | 否 | String | 分析维度 | | compare_dim_column | 否 | String | 对比维度 | | filter | 是 | [ReportFilter] object | 过滤项 | 表3ReportFilter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | **参数解释** 是否关联需求 **约束限制** 不涉及 **取值范围** 不涉及 **默认取值** 不涉及 | | featureUris | 是 | String | **参数解释** 目录uris **约束限制** 不涉及 **取值范围** 大小限制1000内 **默认取值** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [TestReportListVo] object | 请求返回的数据 | 表5TestReportListVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 报表数据 | 表6ReportFilter | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释** 是否关联需求 **取值范围** 不涉及 | | featureUris | String | **参数解释** 目录uris **取值范围** 大小限制1000内 | 表7ProgressReportData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | analyze_dim | [ProgressDimData] object | 分析维度数据 | | compare_dim | Array of [ProgressDimData] objects | 对比维度数据 | 表8ProgressDimData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | 维度名称 | | value | Object | 维度值 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | #### 请求示例 ``` post https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/versions/2e8b14eb90/progress-reports/refresh { "name": "name", "workpiece_type": "case", "analysis_dim_row": "name", "compare_dim_column": "name", "filter": { "featureUris": [ "12" ], "endTime": "2020-09-08 10:42:07", "startTime": "2020-09-08 10:42:07", } } ``` #### 响应示例 **状态码：200** OK ``` { "value" : { "id" : "1", "name" : "报表名称", "type" : 0, "filter" : { }, "workpiece_type" : "case", "daily_chart_data" : [ { } ], "all_chart_data" : [ { } ] } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。