文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 分支迭代报表管理/ 获取进度报表数据 - ShowProgressReport
更新时间:2025-12-27 GMT+08:00
分享

获取进度报表数据 - ShowProgressReport

功能介绍

获取进度报表数据:第三方查询增删改资源,返回查表信息(可限定修改时间)

调用方法

请参见如何调用API

URI

GET /v5/{project_uuid}/versions/{version_uri}/progress-reports

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

version_uri

String

版本uri

表2 Query参数

参数

是否必选

参数类型

描述

type

String

报表类型 1:首页用例库, 2:质量报告

page_no

Integer

页码

page_size

Integer

每页数量

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

is_async_operate

Boolean

是否异步.固定为true:需要在调异步进度接口(/v4/testhub/progress/{operation_uri})获取此次请求的最终处理结果

async_uri

String

异步进度uri,需要在调异步进度接口(/v4/testhub/progress/{operation_uri}获取此次请求的最终处理结果

return_value

Array of TestReportListVo objects

异步进度返回的数据

status

String

异步任务提交状态

表4 TestReportListVo

参数

参数类型

描述

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

报表数据

表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 ProgressReportData

参数

参数类型

描述

analyze_dim

ProgressDimData object

分析维度数据

compare_dim

Array of ProgressDimData objects

对比维度数据

表7 ProgressDimData

参数

参数类型

描述

name

String

维度名称

value

Object

维度值

状态码: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

接口调用失败错误信息

请求示例

get https://{endpoint}/v5/projects/f3087a82b44744c29a1bd69ab6ada154/versions/12sd3123sp/progress-reports?type=1&page_no=1&page_size=5

响应示例

状态码:200

ok

{
  "status" : "success",
  "is_async_operate" : true,
  "async_uri" : "34b49f0c31af4f1e8b0480c60ecfac30v83e00010ukq58ge"
}

状态码

状态码

描述

200

ok

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档