文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试报表管理/ 修改进度报表 - UpdateProgressReport
更新时间:2025-12-27 GMT+08:00
分享

修改进度报表 - UpdateProgressReport

功能介绍

此接口用于在测试质量看板中修改进度报表数据,同页面 测试 -> 测试质量看板 -> 进度报表右侧编辑

调用方法

请参见如何调用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

参数解释:

报表类型

取值范围:

  • 1,用例报表。

  • 2,任务报表。

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

默认取值:

不涉及

featureUris

String

参数解释:

目录uri

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

value

String

参数解释:

调用此接口的返回

取值范围:

  • success,表示接口调用成功。

  • failed,表示接口调用失败。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

不涉及

error_msg

String

参数解释

接口调用失败错误信息

取值范围

不涉及

状态码:500

表8 响应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

OK

{
  "value" : "v90100010icq1no0"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档