文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 报告管理/ 修改单个自定义报表 - updateReport
更新时间：2025-12-27 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改单个自定义报表 - updateReport

功能介绍

修改单个自定义报表

调用方法

请参见如何调用API。

URI

PUT /v4/{project_id}/versions/{version_uri}/custom-reports/{report_uri}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

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

参数解释

创建人

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

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

String

参数解释

请求返回的数据

取值范围

不涉及

status

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/projects/f3087a82b44744c29a1bd69ab6ada154/versions/2dopbu6aaf/custom-reports/121354

{
"type”: "2",
"workpiece_type": "case",
"analysis_dim_row": "CREATORID",
"name":"自定义报表test801",
"compare_dim_column": "STATUS",
"filter": {}
}

响应示例

状态码：200

OK

{
  "value" : "v90200010s29f79t"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 报告管理

相关文档