On this page
...
- "Save checklist data to Jira custom fields" option must be enabled in Global Settings.
- For updating or removing existing checklist Checklist Text custom field (depending on the format you want to use) must must be present on the Edit issue screen. You can configure that in your Jira project settings with these instructions: how to add a custom field to a screen.
For only reading the checklist, there is no such requirement.
...
Available resources (Text format examples)
Get issue checklist
GET /rest/api/2/issue/{issueIdOrKey} (reference)
Returns the details of an issue, including its checklist.
...
The response format of the checklist is documented in separate page: Issue Checklist Text format.
...
Create or update issue checklist
PUT /rest/api/2/issue/{issueIdOrKey} (reference)
Updates the issue including its checklist.
...
The request format of the checklist is documented in separate page: Issue Checklist Text format.
Response errors:
| Code Block |
|---|
{"errorMessages":[],"errors":{"customfield_10034":"Field 'customfield_10034' cannot be set. It is not on the appropriate screen, or unknown."}} |
...
- download current representation of the issue via GET /rest/api/2/issue/{issueIdOrKey}
- knowing Checklist Text field id, extract and parse checklist value:
representation→fields→customfield_xxxxx(parse items by new line characters) - modify parsed checklist according to your needs, for example to check item put "x" in its square brackets (so that "* [] summary" becomes "* [x] summary")
- upload modified value back to the issue via PUT /rest/api/2/issue/{issueIdOrKey}
Add checklist to the issue (cURL)
...