/
Smart Checklist REST API v1.0

Smart Checklist REST API v1.0

Owned by Pavel Pavlovsky (Unlicensed)
Last updated: Jun 18, 2024 by Mariya Solovey
12 min read

Welcome to the Smart Checklist for Jira Server/Data Center platform REST API reference. You can use this REST API to develop integrations between Smart Checklist, Jira, and other 3rd party applications. This page documents the REST resources available in Smart Checklist for the Jira Server/Data Center platform, along with expected HTTP response codes and sample requests.

Looking for simpler integration using Jira REST API and/or 3rd party add-ons? Follow the links below:

Authentication

Use the same authentication that you use to authenticate to Jira applications on your instances.

Resources

/rest/railsware/1.0/checklist

Get checklists GET /rest/railsware/1.0/checklist

Retrieves an existing list of checklists for the given issue key

Query parameters

  • issueKey: string (required)

Responses

  • status 200 application/json Returns a list of all checklists associated with the provided issue key in JSON format
    Example

{ "checklists": [ { "checklistId": 829, "issueId": 13657, "mentionedUsers": { "mariya": "mariya" }, "items": [ { "id": 26403, "checklistId": 829, "label": "INVEST", "rank": 0, "status": null, "quotes": [], "assignees": [], "history": { "id": 19902, "itemId": 26403, "checklistId": 829, "type": "ITEM_CREATED", "from": "", "to": "", "date": 1718634937972, "user": "Admin Admin" }, "mandatory": false, "value": "## INVEST", "level": 2, "type": "HEADING", "isCheckbox": false }, { "id": 26398, "checklistId": 829, "label": "**Independent.** The user story is self contained. @mariya ", "rank": 1, "status": { "id": 1, "rank": 0, "statusState": "UNCHECKED", "name": "TO DO", "color": "GRAY", "default": true }, "quotes": [], "assignees": [ { "id": 518, "userName": "mariya", "displayName": "mariya" } ], "history": { "id": 19904, "itemId": 26398, "checklistId": 829, "type": "ITEM_UPDATED", "from": "TO DO", "to": "TO DO", "date": 1718634945507, "user": "Admin Admin" }, "mandatory": false, "value": "**Independent.** The user story is self contained. @mariya ", "level": null, "type": "item", "isCheckbox": true }, { "id": 26399, "checklistId": 829, "label": "**Negotiable.** The details of the user story can be negotiated and refined, as the team gets a better understanding of the requirements.", "rank": 2, "status": { "id": 1, "rank": 0, "statusState": "UNCHECKED", "name": "TO DO", "color": "GRAY", "default": true }, "quotes": [], "assignees": [], "history": { "id": 19898, "itemId": 26399, "checklistId": 829, "type": "ITEM_CREATED", "from": "", "to": "TO DO", "date": 1718634937972, "user": "Admin Admin"