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

Checklist Content YAML custom field (deprecated)

Owned by Jack (Hunter) Jaroczynski
Last updated: Oct 06, 2021 by Maciej Opala (Deactivated)

Deprecation notice and limitations

Checklist Content YAML field is ignored when multiple checklists are enabled - use Checklist Text instead. When multiple checklists are disabled, Checklist Content YAML stores only items from the default checklist.

Checklist Text not only allows the same functionality as Checklist Content YAML, but also stores multiple checklists (when enabled) and uses much more user-friendly format. 

Checklist Content YAML field may be removed in the future.

General information

Checklist Content YAML field holds the content of the checklist (in YAML format) and can be used to read or modify the checklist, e.g. with Jira REST API or external apps.

Checklist Content YAML custom field is automatically kept in sync with the checklist if:

This field can be modified by Jira users.

Usage

  • REST API support - possibility to change checklist content through REST API (HTTP call).
  • Automation support - integration with automation apps like CLI, Script Runner, Automation, Power Scripts and other.
  • Changelog (Activity Stream) support - any change to the checklist is now tracked in History, All and Activity Stream tabs for an issue. 
  • Flexible search - possibility to search for particular checklist items checked or unchecked.
  • Issue Edit support - possibility to change checklist content through Issue Edit operation.
  • Issue Create support - possibility to add checklist content on the Issue Create form.
  • Export checklist data support - it is possible to retrieve single issue checklist data as well as entire project or JIRA instance. 
  • Import checklist data support - it is possible to fill Checklist Content custom field with external data through REST API
  • Recurring Tasks integration - it is possible to add/define checklist items when creating Recurring Tasks template. 

Checklist Content YAML field details 

Type: Text Field (multi-line)

"Checklist Content YAML" field can be added to Issue Edit or Issue Transition screens and modified by Jira users.


Value:

"Checklist Content YAML" field contains checklist data in YAML format, e.g.:

Find correct YAML

Checklist Content YAML field is deprecated and it will be removed in the future. Please use the Checklist Text field instead. 

If you need a checklist in YAML format for automation purposes, then use "Copy checklist as YAML" option from the checklist "..." menu.

  • Go to any issue page
  • Add checklist items through the Checklist panel as you usually do

  • Use "Copy Checklist as YAML" button from the "..." menu (the YAML representing actual checklist is copied to the clipboard)



    Here is the example YAML copied to clipboard (use Ctrl+P to paste it):

    items:
  - text: '--- Optional checklist header/title'
    checked: false
  - text: item 1
    checked: false
  - text: item 2 with **description**
    checked: false
    description: example description