Installing and configuring the Checklist items plugin

1. Copy the redmine_advanced_checklists plugin folder to the plugins/ folder. The current version does not support operation if redmine is installed in a subdirectory (for example http://example.com/redmine /). It is necessary that redmine is installed at the root (for example http://redmine.example.com / or on a separate port http://example.com:8080 /).
2. Run the migration in the Redmine root folder.bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=redmine_advanced_checklists
3. Stop and start Redmine.sudo/etc/init.d/apache2 stop && sudo /etc/init.d/apache2 start
4. In some redmine installations (for example, when working in docker), it is important to stop and start the redmine server, and not restart it. Sometimes the checklists are not displayed when restarting.

Customization:

1. Configure user roles in Administration -> Roles.
2. Enable the «Checklists» module for projects in the settings of each project or in Administration -> Checklists.
3. Check and change other plugin settings in Administration -> Checklists

API Checklists

• Get all checklist and items for issue

  curl 'https://demo.redmine-kanban.com/questionlist/__ISSUE_ID__' \
  -H 'X-Redmine-API-Key: __API_KEY__' \
  -H 'Content-Type: application/json' \
  -X GET

• Add checklist to issue

  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"}'

• Add item to checklist (parameters "assigned_to_id", "done", "due_date" not required)

  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}'

• Delete item from checklist

  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"}}'

• Change item (set done, rename, assign, change due date)

  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__}}'

Personal checklists

Notes on editing personal checklists

1. Personal checklists can be edited by: author, assignee and person with the role “edit any personal checklists”
2. Personal checklist's author can edit items added to his checklist by other users