Versions Compared

Version Old Version 4 New Version Current
Changes made by

Jennifer Choban

Jennifer Choban

Saved on

Key

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

...

...

Table of Contents
minLevel1
maxLevel7

...

Issue Checklist sets the issue entity property checklist JSON object with the following fields/properties inside:

Code Block
{
  "completedText": "Not Completed", // can also be "Mandatory Completed" or "All Completed"
  "activeItems": 2, // also aliased as "uncheckedItems"
  "allItems": 4,
  "uncheckedMandatoryItems": 1,
  "allMandatoryItems": 2,
  "hasActiveItems": true, // also aliased as "hasUncheckedItems"
  "hasItems": true,
  "allItemsCompleted": false,
  "hasUncheckedMandatoryItems": true,
  "hasMandatoryItems": true,
  "mandatoryItemsCompleted": false,
  "progressText": "Checklist: 2/4",
  "progressPercent": 50,
  "items": Item 1 Item 2 Item 3 Item 4
}

Example usage

Note

Entity properties are read-only.  Changes made directly to the entity properties will not update the checklist and will be overwritten by changes made in the checklist UI (or in any other valid way such as through the API, Checklist Text field, automation, a post function, etc.).

Entity properties can be used in:

  • Automation
    In Automation rules, issue entity properties can be accessed through the smart values feature, e.g. 

Code Block
{{issue.properties.checklist.progressText}}

Get Entity Properties

You can get an issue’s entity properties in the following ways:

...