跳转到主要内容
POST
更新跟进事项

限制说明

使用说明

  • 需要 On-call Pro 许可。
  • 部分更新:未提供的字段以及传 null 的字段均保持不变。传 "" 可清空 description 或 priority;title 和 status 不能为空。
  • 乐观锁 —— version 必须等于事项当前版本;不一致时返回 RequestLocked(HTTP 423),请重新读取事项后重试。
  • 若没有任何字段发生变化,则直接返回当前事项,不校验也不递增 version。
  • 调用方须拥有事项锚点的编辑权限:已绑定复盘时为该复盘,否则为故障。
  • follow_up 事项仅在其故障已关闭时可修改。
  • 负责人、item_type 以及故障/复盘锚点不能在此修改 —— 请使用专用接口。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

跟进事项的部分更新。未提供的字段以及传 null 的字段均保持不变。

work_item_id
string
必填

跟进事项 ID(不透明字符串,最长 128 字符)。

Maximum string length: 128
version
integer<int64>
必填

事项当前的 version(≥ 1),用于乐观锁。

title
string | null

新标题,最多 512 个字符;首尾空白会被去除且不能为空。传 null 或省略则保持不变。

Maximum string length: 512
description
string | null

新描述,最多 65,535 个字符;传 "" 表示清空。传 null 或省略则保持不变。

Maximum string length: 65535
status
enum<string> | null

新状态。传 null 或省略则保持不变。

  • open:未开始。
  • in_progress:处理中。
  • done:已完成。
  • cancelled:已取消。
可用选项:
open,
in_progress,
done,
cancelled,
null
priority
string | null

新的优先级(自由文本),最多 64 个字符;传 "" 表示清空。传 null 或省略则保持不变。

Maximum string length: 64

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

跟进事项变更结果。删除操作不返回 item。