Uncheck/Unselect an option

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:

Placeholders
PlaceholderDescriptionExample
<Name of the field>Name of the field of type Checkboxes/Select list(multiple choices)Tasks list
<Value of the option to uncheck>Value of the option.Verification done

For multi-versions/users/components/groups fields (e.g. Fix Version/s):

Placeholders
PlaceholderDescriptionExample
<Name of the field>Name of the multi-valued fieldversions
<Value to uncheck>Value of the field.5.0.0

For Labels field:

Placeholders
PlaceholderDescriptionExample
<Labels field>Name of the Label fieldLabels
<Label to remove>Label to be removedMerged

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.

  • 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.

References