清单 API
- 获取某个问题的所有清单和项目
curl 'https://demo.redmine-kanban.com/questionlist/__ISSUE_ID__' \
-H 'X-redmine-API-Key: __API_KEY__' \
-H 'Content-Type: application/json' \
-X GET - 向问题添加清单
curl 'https://demo.redmine-kanban.com/questionlist/__ISSUE_ID__' \
-H 'X-redmine-API-Key: __API_KEY__' \
-H 'Content-Type: application/json' \
-X POST \
-d '{"list_type":"Usual", "title":"new checklist"}' - 向清单添加项目（参数 "assigned_to_id"、"done"、"due_date" 为可选）
curl 'https://demo.redmine-kanban.com/question/__CHECKLIST_ID__' \
-H 'X-redmine-API-Key: __API_KEY__' \
-H 'Content-Type: application/json' \
-X POST \
-d '{"title":"new item title ", "assigned_to_id":__USER_ID__, "due_date":"2024-08-01", "done": false}' - 从清单中删除项目
curl 'https://demo.redmine-kanban.com/question/__ITEM_ID__' \
-H 'x-redmine-api-key: __API_KEY__' \
-X 'PATCH' \
-H 'Content-Type: application/json' \
-d '{"data":{"action": "question.delete","updated_at":" 2024-08-16T12:37:56.000Z"}}' - 修改项目（设置完成状态、重命名、分配、更改截止日期）
curl 'https://demo.redmine-kanban.com/question/__ITEM_ID__' \
-H 'x-redmine-api-key: __API_KEY__' \
-X 'PATCH' \
-H 'Content-Type: application/json' \
-d '{"data":{"action":__ACTION_NAME__,"updated_at":__UPDATED_AT__, "value":__NEW_VALUE__}}'
| 描述 | __ACTION_NAME__ | 值示例 | 类型 |
|---|---|---|---|
| 删除 | question.delete | - | - |
| 标记完成/未完成 | question.complete | true/false | bool |
| 重命名 | question.set_title | "new name" | string |
| 分配 | question.set_assigned_to | 1 | integer (user_id) or null |
| 设置截止日期 | question.set_due_date | "2024-08-01" | string |
| 更改排序顺序 | question.set_order | 1 | integer (item) |
清单模板 API
- 获取清单模板类别
curl 'https://demo.redmine-kanban.com/admin/checklist-template-categories' \
-H 'X-redmine-API-Key: __API_KEY__' \
-X GET - 获取所有清单模板
curl 'https://demo.redmine-kanban.com/admin/checklist-templates' \
-H 'X-redmine-API-Key: __API_KEY__' \
-X GET - 创建清单模板
curl 'https://demo.redmine-kanban.com/admin/checklist-templates' \
-H 'Content-Type: application/json' \
-H 'X-redmine-API-Key: __API_KEY__' \
-X POST \
-d '{"title":"new", "list_type":"Usual", "category_id":"id", "is_public": false}' - 获取单个清单模板
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/TEMPLATE_ID' \
-H 'X-redmine-API-key: __API_KEY__' \
-X GET \ - 更新清单模板
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/TEMPLATE_ID' \
-H 'Content-Type: application/json' \
-H 'X-redmine-API-key: __API_KEY__' \
-X PUT \
-d '{"title":"updated", "list_type":"Usual", "category_id":"id", "is_public": true}' - 删除清单模板
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/TEMPLATE_ID' \
-H 'Content-Type: application/json' \
-H 'X-redmine-API-key: __API_KEY__' \
-X DELETE - 创建清单模板项
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/TEMPLATE_ID/elements' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-redmine-API-key: __API_KEY__' \
-X POST \
-d '{"title":"title", "assigned_to_id": 1, "deadline": 1}' - 更新清单模板项
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/ elements/ELEMENT_ID' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-redmine-API-key: __API_KEY__' \
-X PUT \
-d '{"title":"updated", "assigned_to_id": 1, "deadline": 1}' - 删除清单模板项
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/ elements/ELEMENT_ID' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-redmine-API-key: __API_KEY__' \
-X POST
个人清单
- 个人清单可由以下人员编辑：作者、负责人以及具有“编辑任何个人清单”角色的用户。
- 个人清单的作者可以编辑其他用户添加到其清单中的项目。
安装和配置
安装：
- 将 redmine 插件文件夹复制到 plugins/ 文件夹中。
- 在 Redmine 根目录中运行迁移命令。
- 停止并启动 Redmine。在某些 Redmine 安装（例如在 Docker 环境中）中，务必停止并重新启动 Redmine 服务器，而不是重启它。有时在重启时看板不会显示。
自定义：
- 在 管理 -> 角色 中配置用户角色。
- 在每个项目的设置中或在 管理 -> Checklists 中启用 “Checklists” 模块。
- 在 管理 -> Checklists 中检查并修改其他插件设置。
如果您有任何问题或疑问，请发送电子邮件至 [email protected]
