Versions Compared

Key

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

On this page

...

Available resources (Text format examples)

Get issue checklist

GET /rest/api/2/issue/{issueIdOrKey} (reference)

Returns the details of an issue, including its checklist.

...

Create or update issue checklist

PUT /rest/api/2/issue/{issueIdOrKey} (reference)

Updates the issue including its checklist.

...

Available resources (YAML format examples)  

Get issue checklist

GET /rest/api/2/issue/{issueIdOrKey} (reference)

Returns the details of an issue, including its checklist.

...

Create or update issue checklist

PUT /rest/api/2/issue/{issueIdOrKey} (reference)

Updates the issue including its checklist.

...

  • download current representation of the issue via GET /rest/api/2/issue/{issueIdOrKey}
  • knowing Checklist Content YAML (or Checklist Text) field id, extract and parse checklist value: representation → fields → customfield_xxxxx 
    • for Checklist Content YAML field use YAML processing library of your choice
    • for Checklist Text parse items by new line characters
  • modify parsed checklist according to your needs, i.e.:
    • set items checked property to true (Checklist Content YAML)
    • add preceding '[x] ' to each item (Checklist Text)
  • upload modified value back to the issue via PUT /rest/api/2/issue/{issueIdOrKey}

Add checklist to the issue (cURL)

...