文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 项目配置管理/ 更新项目字段配置包含更新字段选项 - RefreshProjectFieldConfig
更新时间：2026-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新项目字段配置包含更新字段选项 - RefreshProjectFieldConfig

功能介绍

此接口用于更新用例字段 "类型"字段时调用.同页面 设置 -> 测试设置 -> 用例字段设置 -> 修改类型字段

调用方法

请参见如何调用API。

URI

POST /v4/projects/{project_id}/field-configs/refresh

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

uri

否

String

字段配置URI标识

description

否

String

描述

table_field_name

否

String

字段名称

value_type

否

String

字段类型(单行文本text、多行文本textArea、单选框radio、多选框checkbox、日期date、数字number、用户user)。

is_display

否

Integer

是否显示

is_required

否

Integer

是否必填

sort_numb

否

Integer

顺序数值

default_value

否

String

默认值

custom_field_uri

否

String

扩展字段uri(用于连表查扩展字段)

resource_type

否

String

参数解释:

资源类型

约束限制:

不涉及

取值范围:

  • TestCase，测试用例。

  • TestItem，特性目录。

默认取值:

TestCase

project_field_config_option_infos

否

Array of ProjectFieldConfigOptionInfo objects

项目字段配置选项入参info数组

delete_project_field_config_option_infos

否

Array of ProjectFieldConfigOptionInfo objects

删除项目字段配置选项
表3 ProjectFieldConfigOptionInfo

参数

是否必选

参数类型

描述

uri

是

String

字段选项URI标识.新增不传，修改、删除使用必传

name

否

String

可选项名称

description

否

String

描述

project_field_config_uri

否

String

字段配置URI标识

sort_numb

否

Integer

顺序数值

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

value

String

参数解释

请求返回的数据

取值范围

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

post https://{endpoint}/v4/projects/f3087a82b44744c29a1bd69ab6ada154/field-configs/refresh

{
  "uri" : "v90200010s1gvf40",
  "description" : "新描述",
  "is_required" : 0
}

响应示例

状态码：200

{
  "result" : {
    "value" : "success"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 项目配置管理

相关文档