You can manipulate checklists using Jira’s REST APIs to:
Retrieve an issue's checklist data.
Use Jira’s Get Issue REST API.
Create an issue and supply checklist data.
Use Jira’s Create Issue REST API.
Update an existing issue’s checklist data.
Use Jira’s Edit Issue REST API.
Get the default value of a checklist, meaning the global items and default items.
Use Jira’s CreateMeta REST API or EditMeta REST API.
The data is available in the
allowedValuesproperty.The status returned by these APIs will only have an ID and no name.
(e.g.{ id: ‘inProgress’ } }and not{ id: ‘inProgress’, name: ‘In Progress’ }).
The only supported update operation is the set operation. This means that all checklist items (including global items) must be provided on every update. As a result, a good operation workflow would be to query the existing issue value, modify the payload, and update it back.
JSON schema structure
When a checklist is manipulated with REST APIs, it will be an array of checklist items.[ checklist-item, checklist-item, ...]
The properties of a checklist item are as follows:
Parameter | Type | Description | Accessibility | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| String[] | A list of the usernames to which the item is assigned (only one assignee is currently supported).
| read-write | ||||||||||
| Boolean | Whether the item is checked or not.
| read-write | ||||||||||
| String | The due date of the item as an ISO string.
| read-write | ||||||||||
| Number | The internal unique ID of the global item to which this item is linked. When no ID is set, the item is considered to be a local item. | read-write | ||||||||||
| Number | The ID for the checklist item.
| read-write | ||||||||||
| Boolean | Whether the item is a header or not.
| read-write | ||||||||||
| Boolean | Whether the item is mandatory or not. | read-write | ||||||||||
| String |
The name of the checklist item.
| read-write | ||||||||||
| Boolean |
Use | read-write | ||||||||||
| String | The numeric priority ID of the item as a string.
| read-write | ||||||||||
| Number | The rank of the item in the checklist, starting from 0. When the checklist is updated, the rank value is ignored, and the order in which the items are set in the array of checklist items is applied. | read | ||||||||||
| Object | The object that contains the status information. Only valid status IDs are accepted.
Also comes with the following sub-parameters: | read-write | ||||||||||
| String | The name of the status. | read | ||||||||||
| String | The status ID. | read-write | ||||||||||
Sample request payload
Here is a sample request that updates a Checklist custom field value with one global item and one local item:
| Code Block | ||
|---|---|---|
| ||
{
"update": {
"customfield_10101": [
{
"set": [
{
"name": "Code Review",
"checked": false,
"mandatory": true,
"priorityId": "2",
"dueDate": "2020-01-25T00:00.000Z",
"assigneeIds": ["admin"],
"globalItemId": 12001,
"id": 1
},
{
"name": "Reviewed by Architect",
"checked": false,
"mandatory": true,
"id": 2,
"status": {
"id": "inProgress"
}
}
]
}
]
}
} |