文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 获取项目测试用例自定义字段列表
更新时间：2025-07-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取项目测试用例自定义字段列表

功能介绍

获取项目测试用例自定义字段列表

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/testcase/field/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

value

Array of ProjectTestCaseFieldVo objects

参数解释

本次查询的记录结果

取值范围

不涉及
表4 ProjectTestCaseFieldVo

参数

参数类型

描述

uri

String

参数解释

项目用例自定义字段主键

取值范围

不涉及

name

String

参数解释

项目用例自定义字段名称

取值范围

不涉及

type

String

参数解释

项目用例自定义字段类型

取值范围

单行文本text、多行文本textArea、单选框radio、多选框checkBox、日期date、数字number、单选用户user

options

String

参数解释

项目用例自定义字段选项

取值范围

数字类型时，数组两个值，第一个是最小值，第二个是最大值

description

String

参数解释

项目用例自定义字段描述

取值范围

不涉及

creator

String

参数解释

项目用例自定义字段创建人

取值范围

不涉及

updater

String

参数解释

项目用例自定义字段更新人

取值范围

不涉及

custom_field_id

Integer

参数解释

项目用例自定义字段id

取值范围

1-25数字

custom_field_name

String

参数解释

项目用例自定义字段名称

取值范围

不涉及

custom_field_param

String

参数解释

项目用例自定义字段入参或者返回参数名称

取值范围

不涉及

type_name

String

参数解释

项目用例自定义字段类型国际化名称

取值范围

不涉及

create_time

String

参数解释

项目用例自定义字段创建时间

取值范围

不涉及

create_time_timestamp

Long

参数解释

项目用例自定义字段创建时间时间戳

取值范围

不涉及

update_time

String

参数解释

项目用例自定义字段更新时间

取值范围

不涉及

update_time_timestamp

Long

参数解释

项目用例自定义字段更新时间时间戳

取值范围

不涉及

project_uuid

String

参数解释

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

取值范围

长度等于32位，包含大小写字母、数字

状态码：400

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：401

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：404

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：500

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

请求示例

GET https://{endpoint}/GT3KServer/v4/90f8dc52eb7b4c47b853c661152ca62d/testcase/field/batch-query

响应示例

状态码：200

OK

{
  "value" : [ {
    "uri" : "v90b000109n4ldea",
    "name" : "用例别名",
    "type" : "text",
    "description" : "",
    "creator" : "dfc5347b9b16491e942ce55ce7f79dbc",
    "custom_field_id" : 3,
    "custom_field_name" : "customField3",
    "custom_field_param" : "custom_field_3",
    "type_name" : "单行文本",
    "create_time" : "2025-03-03 15:59:12",
    "create_time_timestamp" : 1740988752000,
    "project_uuid" : "90f8dc52eb7b4c47b853c661152ca62d"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档