Uncheck/Unselect an option
- Daniel Barrow
Abstract
This code snippet unchecks a specific value of a standard or custom multi-valued type field (typically a multi-select field). The multi-valued fields can either be a collection of objects or a set of values. While unchecking all is easy (set the field with a blank value), unchecking only a particular option/value requires code.Â
Logic
Iterate over the array of currently selected options and add them into a new array ignoring the option that needs to be unchecked.
SnippetÂ
For multi-select fields:
{# Dump options that do not match the search - Requires the "Treat as JSON" option #}
{{ issue.fields['<Name of the field>'] | filter({value:"<Value of the option to uncheck>"} , true ) | dump }}Placeholders
Placeholder | Description | Example |
|---|---|---|
| Name of the field of type Checkboxes/Select list(multiple choices) |
|
| Value of the option. |
|
For multi-versions/users/components/groups fields (e.g. Fix Version/s):
{# Dump values that do not match the search - Requires the "Treat as JSON" option #}
{{ issue.fields['<Name of the multi-valued field>'] | filter({name:"<Value to uncheck>"} , true ) | dump }}Placeholders
Placeholder | Description | Example |
|---|---|---|
| Name of the multi-valued field |
|
| Value of the field. |
|
For Labels field:
{# Dump labels that do not match the search - Requires the "Treat as JSON" option #}
{{ issue.fields['<Labels field>'] | filter("<Label to remove>" , true ) | dump }}Placeholders
Placeholder | Description | Example |
|---|---|---|
| Name of the Label field |
|
| Label to be removed |
|
Examples
The output of this code snippet is an array of objects which you could use to remove a particular option from the selected options of a field in one of the Set Field Value post-functions.
These code snippets require "Treat as JSON" option to be selected
Remove the reporter from the JIRAÂ service desk customers
Clear the option "To Print" after the print has been generated
Remove the label "Merged" when QA re-opens a ticket that has been merged into master and handed over to QA.