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

修改单个自定义报表

功能介绍

修改单个自定义报表

调用方法

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

参数解释

状态

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

moduleIds

否

String

参数解释

级别

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

results

否

String

参数解释

结果

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

labelIds

否

String

参数解释

标签

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

startTime

否

String

参数解释

开始时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

endTime

否

String

参数解释

结束时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

isAssociateIssue

否

String

参数解释

是否关联需求

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

本次请求的处理状态

取值范围:

success|error

result

ResultValueString object

参数解释:

请求结果

取值范围:

非必返

error

ApiError object

参数解释:

错误信息

取值范围:

非必返

request_id

String

参数解释:

请求的唯一id

取值范围:

非必返

address

String

参数解释:

本次请求的受理的服务地址。

取值范围:

非必返
表5 ResultValueString

参数

参数类型

描述

value

String

参数解释

resultObject

取值范围

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

{
  "name" : "新建报表",
  "type" : 1,
  "workpiece_type" : "case"
}

响应示例

状态码：200

修改单个自定义报表返回体

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

状态码

状态码

描述

200

修改单个自定义报表返回体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 报告管理

相关文档