文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 分支迭代报表管理/ 实时获取进度报表数据
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

实时获取进度报表数据

功能介绍

实时获取进度报表数据

调用方法

请参见如何调用API。

URI

POST /v4/{project_uuid}/versions/{version_uri}/progress-reports/refresh

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

是

String

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

version_uri

是

String

分支/计划uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

报表名称

workpiece_type

否

String

工件类型(用例：case,测试套：suite)

analysis_dim_row

否

String

分析维度

compare_dim_column

否

String

对比维度

filter

否

ReportFilter object

过滤条件
表3 ReportFilter

参数

是否必选

参数类型

描述

creatorIds

否

String

参数解释

创建人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

ownerIds

否

String

参数解释

所属人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

ranks

否

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

releaseIds

否

String

参数解释

releaseId

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

status

否

String

参数解释

状态

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

moduleIds

否

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

results

否

String

参数解释

结果

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

labelIds

否

String

参数解释

标签

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

startTime

否

String

参数解释

开始时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

endTime

否

String

参数解释

结束时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

isAssociateIssue

否

String

参数解释

是否关联需求

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueTestReportListVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地
表5 ResultValueTestReportListVo

参数

参数类型

描述

total

Integer

起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值

value

TestReportListVo object

请求返回的数据

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表6 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

报表数据
表7 ReportFilter

参数

参数类型

描述

creatorIds

String

参数解释

创建人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

ownerIds

String

参数解释

所属人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

ranks

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

releaseIds

String

参数解释

releaseId

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

status

String

参数解释

状态

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

moduleIds

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

results

String

参数解释

结果

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

labelIds

String

参数解释

标签

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

startTime

String

参数解释

开始时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

endTime

String

参数解释

结束时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

isAssociateIssue

String

参数解释

是否关联需求

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及
表8 ProgressReportData

参数

参数类型

描述

analyze_dim

ProgressDimData object

分析维度数据

compare_dim

Array of ProgressDimData objects

对比维度数据
表9 ProgressDimData

参数

参数类型

描述

name

String

维度名称

value

Object

维度值
表10 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：400

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表14 响应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" : { }
}

响应示例

状态码：200

OK

{
  "status" : "string",
  "result" : {
    "total" : 1,
    "value" : {
      "id" : "1",
      "name" : "报表名称",
      "type" : 0,
      "filter" : { },
      "workpiece_type" : "case",
      "daily_chart_data" : [ { } ],
      "all_chart_data" : [ { } ]
    },
    "reason" : "string",
    "page_size" : 0,
    "page_no" : 0,
    "has_more" : true
  },
  "error" : { },
  "request_id" : "string",
  "server_address" : "string"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档