API 参考 / work-items

工作项树

GET /api/v1/work-items/tree · listWorkItemTree

按需求聚合的父子层级树。行级模块可见性与 GET /work-items 一致:调用方读不了的那一类 (子任务 / 缺陷)节点连同其子树一起剪掉,不会以「无父节点的孤儿」形式出现。

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

参数

requirementId
string

响应字段 · 200

items(必填)
WorkItemTreeNode[]
items[].workItem(必填)
WorkItem
items[].workItem.id(必填)
string
items[].workItem.displayKey(必填)
string
items[].workItem.requirementId(必填)
string
items[].workItem.roomId(必填)
string
items[].workItem.severity
enum;取值:blocker / major / minor
items[].workItem.resolution
enum;取值:fixed / wontfix / cannot_reproduce / duplicate
items[].workItem.parentId
string
items[].workItem.title(必填)
string
items[].workItem.description
string
items[].workItem.type(必填)
enum;取值:task / dev / qa / bug
items[].workItem.availableTransitions
WorkItemTransition[]
items[].workItem.status(必填)
string
items[].workItem.priority(必填)
enum;取值:P0 / P1 / P2 / P3
items[].workItem.ownerId(必填)
string
items[].workItem.creatorId(必填)
string
items[].workItem.role(必填)
string
items[].workItem.startOn(必填)
string
items[].workItem.dueOn(必填)
string
items[].workItem.estimateDays(必填)
integer
items[].workItem.progress(必填)
integer
items[].workItem.sortOrder(必填)
integer
items[].workItem.customFields
object
items[].workItem.workflowVersionId(必填)
string
items[].workItem.activeSlotKey(必填)
string
items[].workItem.activeUserId(必填)
string
items[].workItem.lastActorId
string
items[].workItem.stateEnteredAt(必填)
string
items[].workItem.slots
object
items[].workItem.createdAt(必填)
string
items[].workItem.updatedAt(必填)
string
items[].children(必填)
WorkItemTreeNode[]
items[].children[].workItem(必填)
WorkItem
items[].children[].children(必填)
WorkItemTreeNode[]

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/work-items/tree?requirementId=…" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "workItem": {
        "id": "018f3c2e-0000-7000-8000-000000000000",
        "displayKey": "示例文本",
        "requirementId": "018f3c2e-0000-7000-8000-000000000000",
        "roomId": "018f3c2e-0000-7000-8000-000000000000",
        "title": "示例标题",
        "type": "task",
        "status": "示例文本",
        "priority": "P0",
        "ownerId": "018f3c2e-0000-7000-8000-000000000000",
        "creatorId": "018f3c2e-0000-7000-8000-000000000000",
        "role": "示例文本",
        "startOn": "2026-08-01",
        "dueOn": "2026-08-01",
        "estimateDays": 1,
        "progress": 1,
        "sortOrder": 1,
        "workflowVersionId": "018f3c2e-0000-7000-8000-000000000000",
        "activeSlotKey": "示例文本",
        "activeUserId": "018f3c2e-0000-7000-8000-000000000000",
        "stateEnteredAt": "示例文本",
        "createdAt": "示例文本",
        "updatedAt": "2026-08-01"
      },
      "children": [
        {}
      ]
    }
  ]
}

合同真值:OpenAPI 3.1(0.1.0)。

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

Workflow 正在加载…