logo

RedmineKanban

Login

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

Description__ACTION_NAME__Example of ValueType
Deletequestion.delete--
Set done/undonequestion.completetrue/falsebool
Renamequestion.set_title"new name"string
Assignquestion.set_assigned_to1integer (user_id) or null
Set due datequestion.set_due_date"2024-08-01"string
Change sort orderquestion.set_order1integer (item)

API templates

  • Get category of checklists-templates

    curl 'https://demo.redmine-kanban.com/admin/checklist-template-categories' \
    -H 'X-redmine-API-Key: __API_KEY__' \
    -X GET

  • Get checklists-templates

    curl 'https://demo.redmine-kanban.com/admin/checklist-templates' \
    -H 'X-redmine-API-Key: __API_KEY__' \
    -X GET

  • Create checklist-template

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

  • Get checklists-template

    curl 'https://demo.redmine-kanban.com/admin/checklist-templates/TEMPLATE_ID' \
    -H 'X-redmine-API-key: __API_KEY__' \
    -X GET \

  • Update checklist-template

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

  • Delete checklist-template

    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

  • Create point of checklist-template

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

  • Update point of checklist-template

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

  • Delete point of checklist-template

    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

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.

Installing and configuring

Installation:

  1. Copy the redmine plugin folder to the plugins/ folder.
  2. Run the migration in the Redmine root folder.
  3. Stop and start Redmine.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, when restarting, the boards are not displayed.

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».

If you have any problems or questions, write us an email [email protected]