文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 分支迭代报表管理/ 修改自定义模板报表设置
更新时间：2025-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改自定义模板报表设置

功能介绍

修改自定义模板报表设置

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

version_uri

是

String

版本uri

report_uri

是

String

报表uri

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

uri

否

String

报表id

name

否

String

报表名称

type

否

Integer

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

workpiece_type

否

String

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

template_config

否

CustomTemplateFilter object

模板配置

data

否

Array of CustomTemplateReportData objects

统计结果
表3 CustomTemplateFilter

参数

是否必选

参数类型

描述

feature_uris

否

Array of strings

目录uri

template_name

否

String

模板名称

template_uri

否

String

模板uri

column_configs

否

Array of ReportTemplateColumnConfig objects

字段配置
表4 ReportTemplateColumnConfig

参数

是否必选

参数类型

描述

filter

否

LogicFilterOperator object

过滤条件

column_name

否

String

字段名称
表5 LogicFilterOperator

参数

是否必选

参数类型

描述

logic_operator

否

String

逻辑操作

field_name

否

String

字段名

field_name_key

否

String

字段名key

field_value

否

String

字段值

field_value_key

否

String

字段值key

field_operator

否

String

字段操作

logic_filters

否

Array of LogicFilterOperator objects

过滤条件
表6 CustomTemplateReportData

参数

是否必选

参数类型

描述

feature_name

否

String

目录名称

data

否

Array of ColumnDataVo objects

列数据
表7 ColumnDataVo

参数

是否必选

参数类型

描述

column_name

否

String

列名

value

否

String

列的值

响应参数

状态码：200

表8 响应Body参数

参数

参数类型

描述

status

String

参数解释:

本次请求的处理状态

取值范围:

success|error

result

ResultValueString object

参数解释:

请求结果

取值范围:

非必返

error

ApiError object

参数解释:

错误信息

取值范围:

非必返

request_id

String

参数解释:

请求的唯一id

取值范围:

非必返

address

String

参数解释:

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

取值范围:

非必返
表9 ResultValueString

参数

参数类型

描述

value

String

参数解释

resultObject

取值范围

不涉及
表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

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

put https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/versions/2e8b14eb90/custom-template-reports/5cde1f449

{
  "uri" : "string",
  "name" : "name",
  "type" : 0,
  "workpiece_type" : "case",
  "template_config" : {
    "feature_uris" : [ "string" ],
    "template_name" : "string",
    "template_uri" : "string",
    "column_configs" : [ { } ]
  },
  "data" : [ {
    "feature_name" : "string",
    "data" : [ {
      "column_name" : "string",
      "value" : "string"
    } ]
  } ]
}

响应示例

状态码：200

OK

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档