Dashboard¶
看板（Kanban / Dashboard）用于在组织维度编排工作项。通过 API 可以查询组织的看板列表与详情、看板内的条目列表，把 Issue 或 Pull Request 加入看板，修改其看板状态，或从看板移除。
看板挂在组织下，路径里的 {owner} 指组织路径。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| 看板 | 组织下的看板列表与详情 | 获取组织看板列表 |
| 看板条目 | 看板内的 Issue / PR 条目列表 | 查询看板内容列表 |
| 条目状态 | 看板列／状态的修改 | 修改看板状态 |
| 条目关联 | 把 Issue/PR 加入看板、更新或移除其关联 | 添加Issue或者Pull Request到看板 |
标识方式¶
- 组织用
{owner}，看板用kanban_id标识。 - 工作项用
{type}（如 issue、pull request）+{iid}定位，另有按仓库维度repo/{repo}的路径。
常见任务¶
注意事项¶
- 路径里是单数
org：/api/v5/org/{owner}/kanban/…，与组织成员接口的/orgs/{org}/…不同。 {owner}在这里指组织路径，不是仓库的 owner；看板是组织级资源。- 更新工作项看板关联的接口路径结构不同：
…/kanban/repo/{repo}/{type}/{iid}，不带kanban_id。 - 加入看板与修改状态是两个动作：
add_item建立关联，state改列／状态，别指望一次调用完成。 - 看板字段值写到 Issue 上用的是 Issue 分组的
kanban_values接口，本组只负责看板侧的关联与状态。
接口列表¶
本模块共 7 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 查询看板内容列表 | GET /api/v5/org/{owner}/kanban/{kanban_id}/item_list |
该接口用于查询指定组织下看板的内容项列表，支持按仓库、来源类型（issue/merge_request）、来源状态、… |
| 2 | 获取组织看板列表 | GET /api/v5/org/{owner}/kanban/list |
该接口用于获取指定组织下的看板列表，支持按状态、可见性筛选及按名称搜索，并可按最新或最老排序、分页返回，同时提供看板… |
| 3 | 获取单个看板详情 | GET /api/v5/org/{owner}/kanban/{kanban_id}/detail |
该接口用于获取指定组织下单个看板的详细信息，包括看板的ID、名称、描述、状态、可见性及更新时间等数据，便于用户查看和… |
| 4 | 添加Issue或者Pull Request到看板 | POST /api/v5/org/{owner}/kanban/{kanban_id}/add_item |
该接口用于将指定仓库中的 Issue 和 Pull Request 添加到指定组织的看板中，通过提交仓库路径及 Is… |
| 5 | 修改看板状态 | PUT /api/v5/org/{owner}/kanban/{kanban_id}/state |
该接口用于修改指定组织下看板的状态，可将看板设置为开启（open）或关闭（closed）。通过组织路径与看板 ID … |
| 6 | 更新Issue或者Pull Request关联的看板 | PUT /api/v5/org/{owner}/kanban/repo/{repo}/{type}/{iid} |
该接口用于更新指定 Issue 或 Pull Request 所关联的看板。调用时需在请求体中提供目标看板的 ID，… |
| 7 | 删除看板关联的Issue或者Pull Request | DELETE /api/v5/org/{owner}/kanban/{kanban_id}/remove_item |
该接口用于删除指定看板中关联的 Issue 或 Pull Request。请求时需提供组织路径、看板 ID，并以数组… |
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc