Interface UpdateIssueFieldOption

Details of the options for a select list issue field.

interface UpdateIssueFieldOption {
    config?: Version2.Version2Models.IssueFieldOptionConfiguration;
    fieldKey: string;
    id: number;
    optionId: number;
    properties?: Record<string, any>;
    value: string;
}

Hierarchy (view full)

Properties

config? fieldKey id optionId 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"

id

id: number

The unique identifier for the option. This is only unique within the select field's set of options.

optionId

optionId: number

The ID of the option to be updated.

Optional properties

properties?: Record<string, any>

The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module.

value

value: string

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

Settings

Member Visibility

Theme

On This Page

configfieldKeyidoptionIdpropertiesvalue