/
Removing items from checklists using ScriptRunner

Removing items from checklists using ScriptRunner

Owned by Maxime Lefebvre
Last updated: 16 Sept 2022
2 min read

You may want to remove some items from a checklist, but not all of them. This can be useful to filter out unnecessary items in a checklist.

To remove all items or reset a checklist, see Replace all items in a checklist using ScriptRunner instead.

Steps

  1. Get the custom field, custom field type and items of your Checklist field.

    def customFieldManager = ComponentAccessor.getCustomFieldManager(); // Remplace the custom field ID with whatever ID your custom field has def checklistField = customFieldManager.getCustomFieldObject("customfield_10101"); def checklistCFType = (ChecklistCFType) checklistField.getCustomFieldType(); Collection<ChecklistItem> items = (Collection<ChecklistItem>) checklistCFType.getValueFromIssue(checklistField, issue);

     

  2. Loop through your items and remove the items you wanted removed.

    // The "toList()" here is important. If not specified, the script will fail with a ConcurrentModificationException for (ChecklistItem item : items.toList()) { if (item.getName() != "Only Accepted Item Name") { items.remove(item); } }

     

  3. Update the issue with the updated item list.

    checklistCFType.updateValue(checklistField, issue, items);

Full example

Here is a full example where items are removed from a Checklist field.

import com.onresolve.scriptrunner.runner.customisers.WithPlugin; @WithPlugin("com.okapya.jira.checklist") import com.okapya.jira.customfields.*; import com.atlassian.jira.component.ComponentAccessor // In this example the issue object comes from an event like in ScriptRunner's Custom Listeners def issue = event.issue; def customFieldManager = ComponentAccessor.getCustomFieldManager(); // Remplace the custom field ID with whatever ID your custom field has def checklistField = customFieldManager.getCustomFieldObject("customfield_10101"); def checklistCFType = (ChecklistCFType) checklistField.getCustomFieldType(); Collection<ChecklistItem> items = (Collection<ChecklistItem>) checklistCFType.getValueFromIssue(checklistField, issue); // The "toList()" here is important. If not specified, the script will fail with a ConcurrentModificationException for (ChecklistItem item : items.toList()) { if (item.getName() != "Only Accepted Item Name") { items.remove(item); } } // Update the value in the issue with the updated collection checklistCFType.updateValue(checklistField, issue, items);
SERVER documentation (On Cloud? Go here.)
Have questions? Contact our Service Desk for help anytime.

Related content