跳转到主要内容
POST
变更自定义字段

限制说明

使用说明

  • 每次调用都会用请求值覆盖 display_name、description、options 和 default_value,不传即被清空,请始终传完整的目标值。
  • field_name、field_type、value_type 不可修改;options 和 default_value 须满足创建时的类型规则。
  • field_id 不存在时返回 InvalidParameter;display_name 在未删除字段中须保持唯一。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json
field_id
string
必填

字段 ID,24 位十六进制 ObjectID。

Pattern: ^[a-f0-9]{24}$
display_name
string

新的显示名称(最长 39 字符),须在未删除字段中保持唯一。每次都会写入。

Maximum string length: 39
description
string

新描述。每次都会写入:不传即清空描述。

options
string[]

替换后的选项列表,规则与创建时相同。注意:更新接口总是用提交的值覆盖 display_name、description、options 和 default_value,因此 single_select/multi_select 字段每次更新都必须传非空 options。

default_value

新的默认值,类型须与字段的 field_type 一致。每次都会写入:不传即清空默认值。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。