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

查询自定义模板

功能介绍

查询自定义模板

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/versions/{version_uri}/custom-template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

version_uri

是

String

版本uri

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListCustomTemplateFilter object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

本次请求的受理的服务地址
表3 ResultValueListCustomTemplateFilter

参数

参数类型

描述

total

Integer

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

value

Array of CustomTemplateFilter objects

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

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表4 CustomTemplateFilter

参数

参数类型

描述

feature_uris

Array of strings

目录uri

template_name

String

模板名称

template_uri

String

模板uri

column_configs

Array of ReportTemplateColumnConfig objects

字段配置
表5 ReportTemplateColumnConfig

参数

参数类型

描述

filter

LogicFilterOperator object

过滤条件

column_name

String

字段名称
表6 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

过滤条件
表7 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/versions/2e8b14eb90/custom-template

响应示例

状态码：200

OK

{
  "status" : "string",
  "result" : {
    "total" : 1,
    "value" : [ {
      "feature_uris" : [ "string" ],
      "template_name" : "string",
      "template_uri" : "string",
      "column_configs" : [ {
        "filter" : {
          "logic_operator" : "string",
          "field_name" : "string",
          "field_name_key" : "string",
          "field_value" : "string",
          "field_value_key" : "string",
          "field_operator" : "string",
          "logic_filters" : [ { } ]
        },
        "column_name" : "string"
      } ]
    } ],
    "reason" : "string",
    "page_size" : 0,
    "page_no" : 0,
    "has_more" : true
  },
  "error" : { },
  "request_id" : "string",
  "server_address" : "string"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档