跳转到主要内容
POST
更新故障自定义字段

限制说明

使用说明

  • 字段必须在账户中存在且处于启用状态;field_value 必须符合字段类型和选项。
  • 省略 field_value 或传 null 会清空该故障上的这个字段。
  • 若新值与当前值相同,则不做任何修改。
  • 修改会在故障时间线上新增一条字段变更记录,并像控制台修改一样触发通知和 Webhook。

授权

app_key
string
query
必填

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

请求体

application/json

更新故障自定义字段值的参数。

incident_id
string
必填

故障 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
field_name
string
必填

自定义字段名(字段的 field_name,而非显示名称)。字段必须存在且处于启用状态;可通过 POST /field/list 查询。

field_value
any

新值,类型须与字段匹配:checkbox 传布尔值,single_select 传一个选项,multi_select 传选项数组,text 传字符串。省略或传 null 表示清空该字段。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。