文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD字段管理/ 更新项目字段
更新时间：2025-10-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新项目字段

功能介绍

更新项目级字段。支持更新字段名称、描述，以及对单选列表、多选列表、层级字段选项的增删改。

调用方法

请参见如何调用API。

URI

POST /v1/ipdprojectservice/projects/{project_id}/meta/fields/{field_id}

表1 路径参数

参数

是否必选

参数类型

描述

field_id

是

String

参数解释：

工作项字段id，可通过查询字段列表接口获取，响应消息体中的id字段的值就是工作项字段id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表（WorkSpace服务）接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：

字段id。

取值范围：

不涉及。

display_name

否

String

参数解释：

字段名称。

取值范围：

不涉及。

created_by

否

String

参数解释：

添加人。

取值范围：

不涉及。

field_type

否

String

参数解释：

字段类型。

取值范围：

不涉及。

show_on_card

否

Boolean

参数解释：

是否显示在新建页。

取值范围：

true：是；false：否。

optional

否

Boolean

参数解释：

是否必填。

取值范围：

true：必填；false：非必填。

all_options

否

Array of OptionEntity objects

参数解释：

字段选项。

取值范围：

不涉及。

default_value

否

String

参数解释：

默认值。

取值范围：

不涉及。

definition_type

否

String

参数解释：

类型。

取值范围：

不涉及。

option

否

OptionEntity object

参数解释：

字段选项。

取值范围：

不涉及。

field_type_id

否

String

参数解释：

下拉类别判断。

取值范围：

不涉及。

user_visibility

否

Boolean

参数解释：

用户是否可见。

取值范围：

不涉及。

modified_date

否

String

参数解释：

修改的日期。

取值范围：

不涉及。

modified_by

否

String

参数解释：

由谁修改。

取值范围：

不涉及。

name

否

String

参数解释：

名称。

取值范围：

不涉及。

has_same_display_name

否

Boolean

参数解释：

是否拥有同名字段。

取值范围：

不涉及。

field_type_name

否

String

参数解释：

列表类型。

取值范围：

不涉及。

created_date

否

String

参数解释：

创建日期。

取值范围：

不涉及。
表3 OptionEntity

参数

是否必选

参数类型

描述

id

否

String

参数解释：

选项id

取值范围：

不涉及

code

否

String

参数解释：

选项code值

取值范围：

不涉及

display_value

否

String

参数解释：

选项名称

取值范围：

不涉及

value

否

String

参数解释：

选项唯一标识

取值范围：

不涉及

level

否

Integer

参数解释：

选项层级。用于区分层级字段的层级

取值范围：

层级字段最多4层

sequence

否

Integer

参数解释：

选项顺序

取值范围：

不涉及

parent_id

否

String

参数解释：

父选项id

取值范围：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释：

字段id。

取值范围：

不涉及。

display_name

String

参数解释：

字段名称。

取值范围：

不涉及。

created_by

String

参数解释：

添加人。

取值范围：

不涉及。

field_type

String

参数解释：

字段类型。

取值范围：

不涉及。

show_on_card

Boolean

参数解释：

是否显示在新建页。

取值范围：

true：是；false：否。

optional

Boolean

参数解释：

是否必填。

取值范围：

true：必填；false：非必填。

all_options

Array of OptionEntity objects

参数解释：

字段选项。

取值范围：

不涉及。

default_value

String

参数解释：

默认值。

取值范围：

不涉及。

definition_type

String

参数解释：

类型。

取值范围：

不涉及。

option

OptionEntity object

参数解释：

字段选项。

取值范围：

不涉及。

field_type_id

String

参数解释：

下拉类别判断。

取值范围：

不涉及。

user_visibility

Boolean

参数解释：

用户是否可见。

取值范围：

不涉及。

modified_date

String

参数解释：

修改的日期。

取值范围：

不涉及。

modified_by

String

参数解释：

由谁修改。

取值范围：

不涉及。

name

String

参数解释：

名称。

取值范围：

不涉及。

has_same_display_name

Boolean

参数解释：

是否拥有同名字段。

取值范围：

不涉及。

field_type_name

String

参数解释：

列表类型。

取值范围：

不涉及。

created_date

String

参数解释：

创建日期。

取值范围：

不涉及。
表5 OptionEntity

参数

参数类型

描述

id

String

参数解释：

选项id

取值范围：

不涉及

code

String

参数解释：

选项code值

取值范围：

不涉及

display_value

String

参数解释：

选项名称

取值范围：

不涉及

value

String

参数解释：

选项唯一标识

取值范围：

不涉及

level

Integer

参数解释：

选项层级。用于区分层级字段的层级

取值范围：

层级字段最多4层

sequence

Integer

参数解释：

选项顺序

取值范围：

不涉及

parent_id

String

参数解释：

父选项id

取值范围：

不涉及

请求示例

更新项目字段

https://{endpoint}/v1/ipdprojectservice/projects/056b156fc4a647a78d92a464afe58de6/meta/fields/1162701752338595843

{
  "field_type_id" : "10001",
  "display_name" : "新建项目单选列表-改名",
  "option" : [ {
    "id" : "1162701752338595841",
    "display_value" : "A",
    "value" : "1162701752338595841",
    "code" : "1162701752338595841",
    "value_py" : "A",
    "sequence" : 0,
    "level" : 1,
    "domain_id" : "1162174826943066113",
    "belong_definition_type" : "5",
    "disabled" : true
  }, {
    "id" : "1162701752338595842",
    "display_value" : "BB",
    "value" : "1162701752338595842",
    "code" : "1162701752338595842",
    "value_py" : "B",
    "sequence" : 1,
    "level" : 1,
    "domain_id" : "1162174826943066113",
    "belong_definition_type" : "5",
    "disabled" : true
  } ],
  "id" : "1162701752338595843",
  "definition_type" : "5"
}

响应示例

状态码：200

ok

{
  "display_name" : "新建项目单选列表-改名",
  "code" : "c7354622570092720128",
  "name" : "c7354622570092720128",
  "id" : "1162701752338595843",
  "show" : false,
  "description" : "",
  "default_value" : "",
  "created_by" : "c2d89e38a64a466f8f945f595df4402d",
  "created_date" : "1755139299000",
  "modified_by" : "c2d89e38a64a466f8f945f595df4402d",
  "modified_date" : "1755140768000",
  "definition_type" : "5",
  "field_type_id" : "10001",
  "alm_field_type_id" : "10001",
  "field_type_name" : "单选列表",
  "using_status" : true,
  "controlled" : false,
  "immutable" : false,
  "optional" : true,
  "show_on_split" : false,
  "show_on_filter" : true,
  "show_on_edit" : false,
  "show_on_table" : true,
  "sort_on_table" : true,
  "no" : 9999,
  "option" : [ {
    "id" : "1162701752338595841",
    "display_value" : "A",
    "value" : "1162701752338595841",
    "code" : "1162701752338595841",
    "value_py" : "A",
    "sequence" : 0,
    "level" : 1,
    "domain_id" : "1162174826943066113",
    "belong_definition_type" : "5"
  }, {
    "id" : "1162701752338595842",
    "display_value" : "B",
    "value" : "1162701752338595842",
    "code" : "1162701752338595842",
    "value_py" : "B",
    "sequence" : 1,
    "level" : 1,
    "domain_id" : "1162174826943066113",
    "belong_definition_type" : "5"
  } ],
  "user_visibility" : true,
  "has_update_privilege" : false,
  "has_same_display_name" : false
}

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题： IPD字段管理

相关文档