Documentation

Issue Field

Issue field module allows the add-on to add a new field in JIRA that will be visible in the issue view. It can be added to any screen just like any other field. It can be referenced in the REST API by $(add-on-key)__$(field-key). For fields of single-select type you additionally need to populate the field with the allowed values. See the REST API for issue field options.

Example

For a full add-on example, see issue field example add-on.

{
  "modules": {
    "jiraIssueFields": [
      {
        "description": {
          "value": "field with team"
        },
        "type": "single_select",
        "extractions": [
          {
            "path": "category",
            "type": "text",
            "name": "categoryName"
          }
        ],
        "name": {
          "value": "Team"
        },
        "key": "team-field"
      }
    ]
  }
}

Properties

description

Required
Yes
Description

Description of the issue field. This will be displayed for the user under the field in the create or edit issue view.

key

Type
string
Required
Yes
Description

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

name

Required
Yes
Description

A human readable name.

type

Type
string
Required
Yes
Allowed values
  • string
  • STRING
  • text
  • TEXT
  • single_select
  • SINGLE_SELECT
  • multi_select
  • MULTI_SELECT
  • number
  • NUMBER
  • Description

    Type of the issue field. String type differs from text type on the allowed operators. For string = is used. Text type uses the ~ operator.

    extractions

    Description

    Extractions used for JQL search. This is valid only when the type is single_select or multi_select.

    template

    Description

    The template used to render options. This is only valid when the type is single_select or multi_select.