更新项目字段 - UpdateIpdProjectField

field_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

project_id

是

String

参数解释：

项目32位ID，项目唯一标识。通过查询IPD项目列表获取，响应消息体中的id字段的值就是项目ID。

约束限制：

不涉及。

取值范围：

32个字符，由英文字母和数字组成。

默认取值：

不涉及。

id

否

String

参数解释：

字段唯一标识。

取值范围：

5~32个字符。

code

否

String

参数解释：

字段编码。在项目中使用时一般使用code作为字段标识而不是字段ID。

取值范围：

不涉及。

display_name

否

String

参数解释：

字段显示名称。

取值范围：

不涉及。

created_by

否

String

参数解释：

字段创建人ID。

取值范围：

不涉及。

created_date

否

String

参数解释：

字段创建时间。时间戳格式，单位毫秒。

取值范围：

不涉及。

modified_by

否

String

参数解释：

字段最后修改人ID。

取值范围：

不涉及。

modified_date

否

String

参数解释：

字段最后修改时间。时间戳格式，单位毫秒。

取值范围：

不涉及。

field_type

否

String

参数解释：

字段类型标识。

取值范围：

不涉及。

field_type_id

否

String

参数解释：

字段类型ID。用于区分不同的字段类型。

取值范围：

不涉及。

field_type_name

否

String

参数解释：

字段类型名称。如单选列表、多选列表、多行文本等。

取值范围：

不涉及。

definition_type

否

String

参数解释：

字段定义类型。用于区分系统字段和自定义字段。

取值范围：

• 1：系统字段。

• 2：系统字段。

• 3：系统字段。

• 4：租户自定义字段。

• 5：项目自定义字段。

show_on_card

否

Boolean

参数解释：

是否显示在云服务类型的迭代看板卡片模式中。

取值范围：

• true：显示。

• false：不显示。

optional

否

Boolean

参数解释：

字段是否为必填项。

取值范围：

• true：必填。

• false：非必填。

controlled

否

Boolean

参数解释：

字段是否受控。如果工作项已经基线，修改受控字段值时会触发变更评审。

取值范围：

• true：受控。

• false：不受控。

immutable

否

Boolean

参数解释：

字段是否不可变。更新接口无法更新不可变字段。

取值范围：

• true：不可变。

• false：可变。

no

否

Integer

参数解释：

字段排序序号。数值越小越靠前显示。

取值范围：

0~9999的整数。

default_value

否

String

参数解释：

字段默认值。创建工作项时自动填充。

取值范围：

不涉及。

option

否

OptionEntity object

参数解释：

字段选项。单选列表类型字段的选项信息，包含选项ID、编码、显示名称等属性。

取值范围：

不涉及。

all_options

否

Array of OptionEntity objects

参数解释：

字段所有选项。多选列表类型字段的全部选项信息，数组元素包含选项ID、编码、显示名称等属性。

取值范围：

不涉及。

has_same_display_name

否

Boolean

参数解释：

是否存在同名字段。用于检测字段名称冲突。

取值范围：

• true：存在同名字段。

• false：不存在同名字段。

id

否

String

参数解释：

选项id。

取值范围：

不涉及

code

否

String

参数解释：

选项code值。

取值范围：

不涉及

display_value

否

String

参数解释：

选项名称。

取值范围：

不涉及

value

否

String

参数解释：

选项唯一标识。

取值范围：

不涉及

level

否

Integer

参数解释：

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

取值范围：

1~4的整数，层级字段最多支持4层。

sequence

否

Integer

参数解释：

选项排序序号。数值越小越靠前显示。

取值范围：

0~2147483647。

parent_id

否

String

参数解释：

父选项ID。层级选项中指向父级选项的标识，顶级选项为空或null。

取值范围：

2~32个字符。

id

String

参数解释：

字段唯一标识。

取值范围：

5~32个字符。

code

String

参数解释：

字段编码。在项目中使用时一般使用code作为字段标识而不是字段ID。

取值范围：

不涉及。

display_name

String

参数解释：

字段显示名称。

取值范围：

不涉及。

created_by

String

参数解释：

字段创建人ID。

取值范围：

不涉及。

created_date

String

参数解释：

字段创建时间。时间戳格式，单位毫秒。

取值范围：

不涉及。

modified_by

String

参数解释：

字段最后修改人ID。

取值范围：

不涉及。

modified_date

String

参数解释：

字段最后修改时间。时间戳格式，单位毫秒。

取值范围：

不涉及。

field_type

String

参数解释：

字段类型标识。

取值范围：

不涉及。

field_type_id

String

参数解释：

字段类型ID。用于区分不同的字段类型。

取值范围：

不涉及。

field_type_name

String

参数解释：

字段类型名称。如单选列表、多选列表、多行文本等。

取值范围：

不涉及。

definition_type

String

参数解释：

字段定义类型。用于区分系统字段和自定义字段。

取值范围：

• 1：系统字段。

• 2：系统字段。

• 3：系统字段。

• 4：租户自定义字段。

• 5：项目自定义字段。

show_on_card

Boolean

参数解释：

是否显示在云服务类型的迭代看板卡片模式中。

取值范围：

• true：显示。

• false：不显示。

optional

Boolean

参数解释：

字段是否为必填项。

取值范围：

• true：必填。

• false：非必填。

controlled

Boolean

参数解释：

字段是否受控。如果工作项已经基线，修改受控字段值时会触发变更评审。

取值范围：

• true：受控。

• false：不受控。

immutable

Boolean

参数解释：

字段是否不可变。更新接口无法更新不可变字段。

取值范围：

• true：不可变。

• false：可变。

no

Integer

参数解释：

字段排序序号。数值越小越靠前显示。

取值范围：

0~9999的整数。

default_value

String

参数解释：

字段默认值。创建工作项时自动填充。

取值范围：

不涉及。

option

OptionEntity object

参数解释：

字段选项。单选列表类型字段的选项信息，包含选项ID、编码、显示名称等属性。

取值范围：

不涉及。

all_options

Array of OptionEntity objects

参数解释：

字段所有选项。多选列表类型字段的全部选项信息，数组元素包含选项ID、编码、显示名称等属性。

取值范围：

不涉及。

has_same_display_name

Boolean

参数解释：

是否存在同名字段。用于检测字段名称冲突。

取值范围：

• true：存在同名字段。

• false：不存在同名字段。

id

String

参数解释：

选项id。

取值范围：

不涉及

code

String

参数解释：

选项code值。

取值范围：

不涉及

display_value

String

参数解释：

选项名称。

取值范围：

不涉及

value

String

参数解释：

选项唯一标识。

取值范围：

不涉及

level

Integer

参数解释：

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

取值范围：

1~4的整数，层级字段最多支持4层。

sequence

Integer

参数解释：

选项排序序号。数值越小越靠前显示。

取值范围：

0~2147483647。

parent_id

String

参数解释：

父选项ID。层级选项中指向父级选项的标识，顶级选项为空或null。

取值范围：

2~32个字符。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述，对error_code的补充解释。

取值范围：

不涉及。

200

ok

400

请求失败的响应。例如无操作权限、项目不存在。