logo

Установка и настройка плагина Чек-листы

  1. Скопируйте папку плагина redmine_advanced_checklists в папку плагинов plugins/. Текущая версия не поддерживает работу если redmine установлен в поддиректории (например http://example.com/redmine/). Необходимо чтобы redmine был установлен в корне (например http://redmine.example.com/ или на отдельном порту http://example.com:8080/).
  2. Запустите миграцию в корневой папке redmine.
  3. Остановите и запустите redmine.
  4. В некоторых установках redmine (например при работе в docker) важно именно остановить и запустить сервер redmine, а не перезапустить. Иногда при перезапуске не отображаются чек-листы.

Настройка:

  1. Настройте роли пользователей в Администрирование -> Роли.
  2. Включите модуль «Чек-листы» для проектов в настройках каждого проекта или в Администрирование -> Чек-листы.
  3. Проверьте и измените другие настройки плагина в Администрирование -> Чек-лист

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.completetrue/falsebool
Переименоватьquestion.set_title"new name"string
Назначитьquestion.set_assigned_to1integer (user_id) or null
Установить срок исполненияquestion.set_due_date"2024-08-01"string
Изменить порядок сортировкиquestion.set_order1integer (item)

Персональные чеклисты

Заметки о редактировании личных чеклистов

  1. Персональные чеклисты могут редактировать: автор, назначенный и человек с ролью «редактировать любые личные чеклисты».
  2. Автор персонального чеклиста может редактировать элементы, добавленные в его чеклист другими пользователями

В случае возникновения проблем или вопросов напишите нам письмо [email protected]