チェックリスト 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 での稼働)では、再起動ではなく停止と起動が重要です。再起動ではボードが表示されないことがあります。
設定:
- 「管理 -> ロール」でユーザーロールを設定してください。
- 各プロジェクトの設定、または「管理 -> チェックリスト」で「チェックリスト」モジュールを有効にしてください。
- 「管理 -> チェックリスト」でプラグインのその他の設定を確認・変更してください。
問題や質問が発生した場合は、次のメールアドレスまでご連絡ください [email protected]