Rate this page:
This module allows the app to add a new issue field to Jira.
The key of the field, that can be used to reference the field in the REST API, is: `$(app-key)__$(module-key)`.
Available options for fields of the `single_select` or `multi-select` type are managed with the REST API for issue field options.
Example
For a full add-on example, see issue field example app.1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
{
"modules": {
"jiraIssueFields": [
{
"description": {
"value": "field with team"
},
"type": "single_select",
"extractions": [
{
"path": "category",
"type": "text",
"name": "categoryName"
}
],
"name": {
"value": "Team"
},
"key": "team-field"
}
]
}
}
description
Type | |
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 Example1 2 3 4
|
value |
| ||||||||
i18n |
|
key
Type | |
Max length | 100 |
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 9
Will have a configuration page module with a URL of |
name
Type | |
Required | Yes |
Description | A human readable name. Represents a string that can be resolved via a localization properties file. You can use the same Example1 2 3 4
|
value |
| ||||||||
i18n |
|
type
Type | |
Required | Yes |
Allowed values |
|
Description | The type of the field. The following types are available:
|
extractions
Type | |
Description | Extractions used for JQL search. This is valid only when the |
property
Type | |
Description | The property that stores the field value. Required when the Defines an issue property that will store the value for the issue field of the Example 1 2 3 4 5 6
|
key |
| ||||||||
path |
| ||||||||
type |
|
template
Type | |
Description | The template used to render options. This is only valid when the Defines the template used to render issue field options in the UI view. |
type |
| ||||||||
url |
|
Rate this page: