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.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "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

Type
i18n Property
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.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4
5
{
  "name": {
    "value": "My Label"
  }
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

key

Type
string
Required
Yes
Pattern
^[a-zA-Z0-9-]+$
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:

1
2
3
4
5
6
7
8
{
    "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

Type
i18n Property
Required
Yes
Description

A human readable name.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4
5
{
  "name": {
    "value": "My Label"
  }
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

type

Type
string
Allowed values
  • string
  • STRING
  • text
  • TEXT
  • single_select
  • SINGLE_SELECT
  • multi_select
  • MULTI_SELECT
  • number
  • NUMBER
    • Required
    Yes
    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

    Type
    [Issue Field Option Property Index, ... ]
    Description

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

    template

    Type
    Issue Field Template
    Description

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

    Defines the template used to render issue field options in the UI view.

    Properties

    type
    Type
    string
    Required
    Yes
    Description

    Type of the template.

    url
    Type
    string
    Required
    Yes
    Description

    If the type is 'link' then this specifies the URL template for the link. It is possible to use context parameters in the template.

    The URL may be relative or absolute. If it is the former, then the Jira context path will be prepended automatically.

    The following context parameters are available:

    • option.id, option.key, option.properties
    • issue.id, issue.key
    • project.id, project.key
    • user.id (deprecated), user.name (deprecated), user.accountId