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

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

功能介绍

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

调用方法

请参见如何调用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

资源类型

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参数

参数

参数类型

描述

status

String

success|error

result

ResultValueString object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

本次请求的受理的服务地址
表5 ResultValueString

参数

参数类型

描述

total

Integer

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

value

String

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

reason

String

业务失败的提示内容

page_size

Integer

分页大小

page_no

Integer

分页编码

has_more

Boolean

是否有更多
表6 ApiError

参数

参数类型

描述

code

String

业务失败的错误编码

reason

String

业务失败的提示内容

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

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

{
  "uri" : "12121",
  "description" : "新描述"
}

响应示例

状态码：200

OK

{
  "status" : "ok",
  "result" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 项目配置管理

相关文档