Versions Compared

Key

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


Info

"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 automaticallykept  kept in sync with the checklist if "Save checklist data to Jira custom fields" option is enabled. The field can be modified by Jira users.


Info

"Checklist Content YAML" field is meant to be used by automation scripts as it requires very strict formatting. 

If you want to manually access or modify the field or copy-paste it then please use "Checklist Text" custom field.

Usage

  • REST API support - possibility to change checklist content through REST API (HTTP call).
  • Automation support - integration with automation apps like CLIScript 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 

TypeText Field (multi-line)

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

Image Modified

Value:

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

...