Page Comparison

...

📖 Overview

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

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

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

🔒 Authentication

Get your API token from https://id.atlassian.com/manage/api-tokens  check .
Check out instructions :here →  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

curl --location --request PUT \
--url 'https://your-domain.atlassian.net/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"'

...

curl --request GET \
--url 'https://your-domain.atlassian.net/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

Set the checklist

curl --request PUT \
--url 'https://your-domain.atlassian.net/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

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

Insert excerptSupportSupportnopaneltrueHope everything works for you! 🚀

...