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

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

功能介绍

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

调用方法

请参见如何调用API。

URI

GET /v4/{project_id}/testcase/field/{uri}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

uri

是

String

项目测试用例自定义字段Uri

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueProjectTestCaseFieldVo object

请求返回的数据

error

ApiError object

错误信息

request_id

String

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

server_address

String

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

参数

参数类型

描述

total

Integer

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

value

ProjectTestCaseFieldVo object

请求返回的数据

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表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位，包含大小写字母、数字
表5 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

get https://{endpoint}/v4/f3087a82b44744c29a1bd69ab6ada154/testcase/field/v92u00010id84o7m

响应示例

状态码：200

获取项目测试用例自定义字段返回体

{
  "status" : "success",
  "result" : {
    "value" : {
      "uri" : "v92u00010id84o7m",
      "name" : "新自定义字段",
      "custom_field_id" : "25",
      "project_uuid" : "f3087a82b44744c29a1bd69ab6ada154"
    }
  }
}

状态码

状态码

描述

200

获取项目测试用例自定义字段返回体

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档