Checklist Progress & Progress Percent

Checklist Progress

Checklist Progress is a read-only, single line text field with a value of “Checklist: x/y” where x is the number of completed items in the list and y is the total number of items in the list. The value in the Checklist Progress field is updated after every interaction with the checklists, as well as during the synchronization process after any changes in the Global Checklists.

Initial State

The initial value of Checklist Progress is null, meaning that the field will be empty for issues where users have not interacted with a checklist. Once a user interacts with the items on a Global or Local checklist, the field value will be set and will never be null again.

Checklist Progress %

Checklist Progress % is a read-only, number field that shows the percent of checklist items which have been completed. The value in the Checklist Progress % field is updated after every interaction with the checklists, as well as during the synchronization process after any changes in the Global Checklists.

Initial State

The initial value of Checklist Progress % is null. This means that the field will be empty for issues that do not have a checklist. However, if an issue has a Global checklist or a Local Checklist, the initial value of the field will be replaced by 0 or a value that reflects the actual progress of the checklist.

Uses

Can be added to screens or issue cards in Jira boards
Can be shown in search results
Can be read via the Jira API

More Details

If there are multiple checklists on the issue, then progress will be shown as “x/y” where x is the total number of completed items on all of the checklists (including Global Checklists) and y is the total number of items on all of the checklists (including Global Checklists).
Changes to these fields do not trigger the Issue updated webhook and therefore cannot be used to trigger automation.

How to Find the Custom Field ID

When using custom fields with automation, scripts, etc. you will need the ID number of the custom field.

To find the ID of the custom field:

Log in as a Jira Administrator.
Go to Jira Settings > Issues > Custom fields.
Search for the indicated custom field.
Click the More menu (…) and select Edit Details.
Copy the URL of the page. The URL will end with the ID number of the custom field.

Custom fields can be duplicated by some errors or rare scenarios. If you are experiencing issues with accessing custom fields, make sure you are referencing the custom field that is currently used by Issue Checklist.

Using REST API
Getting custom field IDs using Jira Rest API is a fairly easy process. By using the REST API request, you can easily obtain the custom field ID. Here is an example REST API request (you can open using web browser):

GET https://test-instance.atlassian.net/rest/api/3/field/search?type=custom&query=Checklist

You can run the request using a web browser. However, please keep in mind that this requires administrative privileges, which means that you need to be logged in to an administrator account to run the request successfully.

The result of this request will contain the custom field ID that you're looking for. The response will include a values array that contains a list of custom fields. Each custom field in the array will have an id attribute that you can use to identify it.

It's important to note that the description information in the response can help you identify fields from other instances. This information can provide context about the purpose of the field, allowing you to determine if it's the one you're looking for.

Example result:

JSON

{
  "maxResults": 50,
  "startAt": 0,
  "total": 2,
  "isLast": true,
  "values": [
    {
      "id": "customfield_10034",
      "name": "Checklist Completed",
      "schema": {
        "type": "string",
        "custom": "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
        "customId": 10034
      },
      "description": "Do not delete. Custom field with Checklist completion status. Automatically created and managed by Issue Checklist Pro (Sandbox)."
    },
    {
      "id": "customfield_10099",
      "name": "Checklist Completed",
      "schema": {
        "type": "string",
        "custom": "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
        "customId": 10099
      },
      "description": "Do not delete. Custom field with Checklist completion status. Automatically created and managed by Issue Checklist Free."
    }
}