We have a new documentation site. Please go here to see the latest.

Issue entity properties

On the page

Available properties

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

  "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

Entity properties are read-only. If you change them on your own, it won't update the checklist and your change will be overwritten when the checklist changes in UI or in any other valid way (e.g. through API, custom fields, post function, Automation rule, etc.), 

Entity properties can be used in:

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


which, for example, you can next send to your Slack channel as explained in Automation docs.

Access all properties in Jira

A full list of entity properties can be accessed directly in Jira:

  • install Entity Property app in your Jira (not recommended in production Jira)
  • visit an issue page
  • access Entity properties tab as presented below