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

修改进度报表

功能介绍

修改进度报表

调用方法

请参见如何调用API。

URI

PUT /v4/{project_uuid}/versions/{version_uri}/progress-reports/{report_uri}

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

是

String

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

version_uri

是

String

版本uri

report_uri

是

String

报告uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

报表名称

type

否

Integer

报表类型 1：首页用例库， 2：质量报告

workpiece_type

否

String

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

analysis_dim_row

否

String

分析维度

compare_dim_column

否

String

对比维度

filter

否

ReportFilter object

过滤项
表3 ReportFilter

参数

是否必选

参数类型

描述

creatorIds

否

String

参数解释:

自定义报表创建人用户ID，指定由对应用户创建的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接

默认取值:

不涉及

ownerIds

否

String

参数解释:

自定义报表所属人用户ID，指定由对应用户作为Owner的用例或测试套进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字）,可选择多个用户ID，用逗号拼接

默认取值:

不涉及

ranks

否

String

参数解释:

测试用例级别，指定对应用例级别的用例进行报表生成

约束限制:

不涉及

取值范围:

级别为数字, 可选择多个用例级别，用逗号拼接

默认取值:

不涉及

releaseIds

否

String

参数解释:

需求管理中迭代计划的ID，指定关联了对应迭代的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个迭代ID，用逗号拼接

默认取值:

不涉及

status

否

String

参数解释:

测试用例状态ID, 指定对应用例状态下的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符（数字），可选择多个状态ID，用逗号拼接

默认取值:

不涉及

moduleIds

否

String

参数解释:

需求管理中定义的模块ID，指定关联了对应模块的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个模块，用逗号拼接

默认取值:

不涉及

results

否

String

参数解释:

测试用例结果的状态编码，指定对应用例结果的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-255字符（数字），可选择多个结果ID，用逗号拼接

默认取值:

不涉及

labelIds

否

String

参数解释:

测试用例关联的标签ID，指定对应关联了该标签的用例进行报表生成

约束限制:

不涉及

取值范围:

长度为1-1000字符（字母或数字），可选择多个标签，用逗号拼接

默认取值:

不涉及

startTime

否

String

参数解释:

开始时间，指定创建时间在该时间之后的用例进行报表生成

约束限制:

与结束时间配合，过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07

默认取值:

不涉及

endTime

否

String

参数解释:

结束时间，指定创建时间在该时间之前的用例进行报表生成

约束限制:

与开始时间配合，过滤在指定范围内的用例

取值范围:

日期时间格式为yyyy-MM-dd hh:mm:ss，如：2020-09-08 10:42:07

默认取值:

不涉及

isAssociateIssue

否

String

参数解释:

是否关联需求，指定已关联需求或未关联需求的用例进行报表生成

约束限制:

不涉及

取值范围:

true或false

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueString object

请求结果

error

ApiError object

错误信息

request_id

String

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

server_address

String

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

参数

参数类型

描述

total

Integer

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

value

String

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表6 ApiError

参数

参数类型

描述

code

String

参数解释

错误编码

取值范围

不涉及

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

请求示例

put https://{endpoint}/v4/a5eb0d410ea341a192f7c12483568985/versions/v90100010gpop33g/progress-reports/v90100010icq1no0?_=1750306483952

{
  "type" : "2",
  "workpiece_type" : "progress",
  "analysis_dim_row" : "progress",
  "name" : "1111111111111112222222222",
  "filter" : {
    "startTime" : "2025-06-08 23:59:59",
    "endTime" : "2025-06-09 23:59:59"
  }
}

响应示例

状态码：200

修改进度报表返回体

{
  "status" : "success",
  "result" : {
    "value" : "v90100010icq1no0"
  }
}

状态码

状态码

描述

200

修改进度报表返回体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 测试报表管理

相关文档