Interface CreateIssueFieldOption

interface CreateIssueFieldOption {
    config?: Version2.Version2Models.IssueFieldOptionConfiguration;
    fieldKey: string;
    properties?: {};
    value: string;
}

Hierarchy (view full)

Properties

config? fieldKey properties? value

Properties

Optional config

config?: Version2.Version2Models.IssueFieldOptionConfiguration

fieldKey

fieldKey: string

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Optional properties

properties?: {}

The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.

Type declaration

    value

    value: string

    The option's name, which is displayed in Jira.

    Settings

    Member Visibility

    Theme

    On This Page

    configfieldKeypropertiesvalue