Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page explains how to access the value of User-created custom fields of different field types using Groovy.  You can access them using the getters of the Issue interface. However, accessing custom fields using the native Jira API can be much more complex, depending on the type of the custom field being accessed. Instead, it is easier to access the fields using the methods provided by JMCF. 

...

Panel
borderStylesolid

Checkboxes / Multi-select list

  • Description: A Field of the type Checkboxes/Multi-select list, is an array of objects. Each selected option is an object in itself.

  • Accessing a field of Checkboxes/Multi-select list type: You can access a custom field of Checkboxes/Multi-select type using any of the following getters of the Issue interface:

...

Panel
borderStylesolid

Radio buttons / Single-select list

...

Panel
borderStylesolid

Cascading

  • Description: A field of Cascading type is a Map with the Key as String and Value as the Option

  • Accessing a field of Cascading type: You can access a custom field of Cascading type using any of the following getters of the Issue interface:
    • get("<Your custom field name>") or get("customfield_xxxxx") that returns a Map<StringOption>
      • Example: Parent of the cascading field

        Code Block
        languagegroovy
        issue.get("Cascade")?.get(null)?.getValue()


      • Example: Return parent and child of the cascading field as Strings separated by a comma:

        Code Block
        languagegroovy
        if (issue.get("<Cascading type field name>"))
        {
          if(issue.get("<Cascading type field name>").get("1"))
          {
            return issue.get("<Cascading type field name>").get(null).getValue() + "," + issue.get("<Cascading type field name>").get("1") 
          }
          return issue.get("<Cascading type field name>").get(null).getValue()
        }


    • getAsString("<Your custom field name>") or getAsString("customfield_xxxxx") that returns a String with the parent and child value separated by a comma

      • Example: Return parent and child of the cascading field as Strings separated by a comma:

        Code Block
        languagegroovy
        issue.getAsString("<Cascading type field name>")


...

Panel
borderStylesolid

Single-Group Picker

  • Description: A field of Single-group picker type is an object that represents a group.

  • Accessing a field of Single-Group picker type: You can access a custom field of Single-group picker type using any of the following getters of the Issue interface:

...

Panel
borderStylesolid

Multi-Group Picker

  • Description: A field of Multi-group picker is an array of objects. Each group is an object in itself.

  • Access a field of Multi-group picker typeYou can access a custom field of Multi-group picker type using any of the following getters of the Issue interface:
      • Example: Is a specific group selected?

        Code Block
        languagegroovy
        linenumberstrue
        issue.get("<Multi-group picker name>")?.find() { it.getName() == "Group name" } != null


    • getAsString("<Your custom field name>") or getAsString("customfield_xxxxx") that returns a String with comma separated Group names

      • Example: Groups selected

        Code Block
        languagegroovy
        linenumberstrue
        issue.getAsString("<Multi-group picker name>")


...

Panel
borderStylesolid

Single-User picker

...

Panel
borderStylesolid

Multi-user picker

  • Description: A field of multi-user picker type is an array of objects. Each user is an object in itself.

  • Accessing a field of Multi-user picker typeYou can access a custom field of Multi-user picker type using any of the following getters of the Issue interface:

...

Panel
borderStylesolid

Watchers field type

  • Description: A field of the Watchers type is an array of objects. Each user is an object in itself.

  • Accessing a field of Watchers field typeYou can access a custom field of Watchers field type using any of the following getters of the Issue interface:

...

Panel
borderStylesolid

Single-version picker

  • Description: A field of Single-version picker type is an object that represents a version.

  • Accessing a field of Single-Version picker typeYou can access a custom field of Single-version picker type using any of the following getters of the Issue interface

...

Panel
borderStylesolid

Multi-version picker

  • Description: A field of Multi-version picker type is an array of objects. Each version is an object in itself.

  • Accessing a field of Multi-version picker typeYou can access a custom field of Multi-version picker type using any of the following getters of the Issue interface:
      • Example: Release date of the last versions

        Code Block
        languagegroovy
        linenumberstrue
        issue.get("<Multi-Version picker field name>")?.last()?.getReleaseDate()


    • getAsString("<Your custom field name>") or getAsString("customfield_xxxxx") that returns a String with comma separated Version names

      • Example: Selected versions:

        Code Block
        languagegroovy
        linenumberstrue
        issue.getAsString("<Multi-Version picker field name>")


...

Panel
borderStylesolid

Single-line text field type

...

Panel
borderStylesolid

Multi-line text field type

...

Panel
borderStylesolid

Read-only text field type

...

Panel
borderStylesolid

Date picker

...

Panel
borderStylesolid

Date time picker

...

Panel
borderStylesolid

Numeric field

...

Panel
borderStylesolid

Project picker type

  • Description: A field of Project picker type is an object describing a project.

  • Accessing a field of Project picker typeYou can access a custom field of Project picker type using any of the following getters of the Issue interface:

...

Panel
borderStylesolid

URL field type

...