API checklist
- Pobierz wszystkie checklisty i ich punkty dla zadania
curl 'https://demo.redmine-kanban.com/questionlist/__ISSUE_ID__' \
-H 'X-redmine-API-Key: __API_KEY__' \
-H 'Content-Type: application/json' \
-X GET - Dodaj checklistę do zadania
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"}' - Dodaj punkt do checklisty (parametry «assigned_to_id», «done», «due_date» nie są obowiązkowe)
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}' - Usuń punkt z checklisty
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"}}' - Zmień punkt (ustaw jako wykonany, zmień nazwę, przypisz, zmień termin wykonania)
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__}}'
| Opis | __ACTION_NAME__ | Przykładowa wartość | Typ |
|---|---|---|---|
| Usuń | question.delete | - | - |
| Ustaw (nie)wykonanym | question.complete | true/false | bool |
| Zmień nazwę | question.set_title | "new name" | string |
| Przypisz | question.set_assigned_to | 1 | integer (user_id) or null |
| Ustaw termin wykonania | question.set_due_date | "2024-08-01" | string |
| Zmień kolejność sortowania | question.set_order | 1 | integer (item) |
API szablony
- Pobierz kategorię szablonów checklist
curl 'https://demo.redmine-kanban.com/admin/checklist-template-categories' \
-H 'X-redmine-API-Key: __API_KEY__' \
-X GET - Pobierz szablony checklist
curl 'https://demo.redmine-kanban.com/admin/checklist-templates' \
-H 'X-redmine-API-Key: __API_KEY__' \
-X GET - Utwórz szablon checklist
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}' - Pobierz szablon checklisty
curl 'https://demo.redmine-kanban.com/admin/checklist-templates/TEMPLATE_ID' \
-H 'X-redmine-API-key: __API_KEY__' \
-X GET \ - Zaktualizuj szablon checklist
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}' - Usuń szablon checklist
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 - Utwórz punkt kontrolny szablonów checklist
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}' - Zaktualizuj punkt kontrolny szablonów checklist
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}' - Usuń punkt kontrolny szablonów checklist
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
Osobiste checklisty
- Osobiste checklisty mogą edytować: autor, przypisany i osoba z rolą «edytuj dowolne osobiste checklisty».
- Autor osobistej checklisty może edytować elementy dodane do jego checklisty przez innych użytkowników.
Instalacja i konfiguracja wtyczki
Instalacja:
- Skopiuj folder wtyczki redmine do folderu plugins/.
- Uruchom migrację w głównym folderze Redmine.
- Zatrzymaj i uruchom ponownie Redmine.W niektórych instalacjach Redmine (np. podczas pracy w docker) ważne jest, aby właśnie zatrzymać i uruchomić serwer Redmine, a nie go zrestartować. Czasami przy restartowaniu nie wyświetlają się tablice.
Konfiguracja:
- Skonfiguruj role użytkowników w Administracja -> Role.
- Włącz moduł «Checklisty» dla projektów w ustawieniach każdego projektu lub w Administracja -> Checklisty.
- Sprawdź i zmień inne ustawienia wtyczki w Administracja -> Checklisty.
W przypadku problemów lub pytań napisz do nas e-mail [email protected]