Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can use Jira REST API to work with the checklists.

Overview

You can read/write checklists by accessing any of checklist storage:

  • use “Checklists” custom fields. Read more about custom fields setup here "Checklists" Custom Field

  • use com.railsware.SmartChecklist.checklist Issue property which is immediately available upon addon setup.

Authentication

Get your API token from https://id.atlassian.com/manage/api-tokens  check out instructions: https://confluence.atlassian.com/cloud/api-tokens-938839638.html

Then use the following approach

Examples

Using com.railsware.SmartChecklist.checklist issue property

Jira API reference

Set the checklist

Code Block
curl --location --request PUT \
--url 'https://your-domain.atlassian.com/rest/api/2/issue/{issueIdOrKey}/properties/com.railsware.SmartChecklist.checklist' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"- ToDo List\n+ Checked\nx Skipped\n~ In Progress\n"}'

Get the checklist

Code Block
curl --request GET \
--url 'https://your-domain.atlassian.com/rest/api/2/issue/{issueIdOrKey}/properties/com.railsware.SmartChecklist.checklist' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' 

Using “Checklists” custom field

Jira API reference

Note

customfield_10001 custom field id might be different on your instance. Make sure you use the correct one.

Set the checklist

Code Block
curl --request PUT \
--url 'https://your-domain.atlassian.com/rest/api/2/issue/{issueIdOrKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "fields": {
    "customfield_10001": "- ToDo List\n+ Checked\nx Skipped\n~ In Progress\n"
  }
}'

Get the checklist

Your curl request

Code Block
curl --request GET \
--url 'https://your-domain.atlassian.com/rest/api/2/issue/{issueIdOrKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' 

Response from server

Code Block
languagejs

Table of Contents

Check an example implementation with ScriptRunner for Jira (Cloud)


Excerpt Include
Support
Support
nopaneltrue