API 参考 / requirement-rooms

需求室列表

GET /api/v1/rooms · listRooms

返回当前项目的需求室列表,每室附聚合计数(需求数 / 缺陷数 / 有风险数)供卡片墙展示; 当前项目由 Host/session 上下文解析。

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

参数

limit
integer

响应字段 · 200

items(必填)
Room[]
items[].id(必填)
string
items[].displayKey(必填)
string
items[].name(必填)
string
items[].description
string
items[].module(必填)
string
items[].status(必填)
enum;取值:active / archived
items[].requirementCount(必填)
integer
items[].requirementOpenCount(必填)
integer
items[].bugCount(必填)
integer
items[].bugOpenCount(必填)
integer
items[].atRiskCount(必填)
integer
items[].feishuChat
RoomFeishuChat
items[].feishuChat.status(必填)
enum;取值:creating / active / failed
items[].feishuChat.source(必填)
enum;取值:created / bound
items[].feishuChat.chatId(必填)
string
items[].feishuChat.chatName(必填)
string
items[].feishuChat.error(必填)
string
items[].feishuChat.invitedCount
integer
items[].feishuChat.skippedUnboundCount
integer
items[].feishuChat.updatedAt(必填)
string
items[].createdAt(必填)
string
items[].updatedAt(必填)
string

错误

请求示例(curl)

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

响应示例

HTTP/1.1 200
{
  "items": [
    {
      "id": "018f3c2e-0000-7000-8000-000000000000",
      "displayKey": "示例文本",
      "name": "示例标题",
      "module": "示例文本",
      "status": "active",
      "requirementCount": 1,
      "requirementOpenCount": 1,
      "bugCount": 1,
      "bugOpenCount": 1,
      "atRiskCount": 1,
      "createdAt": "示例文本",
      "updatedAt": "2026-08-01"
    }
  ]
}

合同真值:OpenAPI 3.1(0.1.0)。

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

Workflow 正在加载…