API 参考 / handoffs

某张单据上的交接纪要(最近在前)

GET /api/v1/handoffs · listHandoffs

按宿主对象(targetType + targetId)返回该单据上的交接纪要,倒序、keyset 游标分页, 口径与 GET /rooms/{roomId}/handoffs 完全一致。

targetType 取值 requirement / work_item / bug;服务端按目标实际类型归一 (type=bug 的工作项一律归为 bug),所以回包里的 targetType 可能与查询参数不同。

鉴权:项目 API Token(Authorization: Bearer wfp_…)。详见 Agent 接入。

参数

targetType(必填)
string
targetId(必填)
string
limit
integer
cursor
string

响应字段 · 200

items(必填)
Handoff[]
items[].id(必填)
string
items[].roomId
string
items[].targetType(必填)
enum;取值:requirement / work_item / bug
items[].targetId(必填)
string
items[].targetDisplayKey(必填)
string
items[].targetTitle(必填)
string
items[].agentLabel(必填)
string
items[].summary(必填)
string
items[].handoffRef(必填)
string
items[].createdBy(必填)
string
items[].createdAt(必填)
string
items[].mirrored(必填)
boolean
nextCursor(必填)
string

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/handoffs?targetType=…&targetId=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "id": "018f3c2e-0000-7000-8000-000000000000",
      "targetType": "requirement",
      "targetId": "018f3c2e-0000-7000-8000-000000000000",
      "targetDisplayKey": "示例文本",
      "targetTitle": "示例标题",
      "agentLabel": "示例文本",
      "summary": "一段描述文字",
      "handoffRef": "示例文本",
      "createdBy": "示例文本",
      "createdAt": "示例文本",
      "mirrored": true
    }
  ],
  "nextCursor": "示例文本"
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…