jira.js
    Preparing search index...

    Function updateIssueFieldOption

    • Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.

      Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

      Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

      Parameters

      • client: Client
      • parameters: {
            config?: {
                attributes?: (string & {} | "defaultValue" | "notSelectable")[];
                scope?: {
                    global?: {
                        attributes?: ((...) & (...) | "defaultValue" | "notSelectable")[];
                        [key: string]: unknown;
                    };
                    projects?: number[];
                    projects2?: {
                        attributes?: ((...) | (...) | (...))[];
                        id?: number;
                        [key: string]: unknown;
                    }[];
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            fieldKey: string;
            id: number;
            optionId: number;
            properties?: Record<string, any>;
            value: string;
        }
        • Optionalconfig?: {
              attributes?: (string & {} | "defaultValue" | "notSelectable")[];
              scope?: {
                  global?: {
                      attributes?: ((...) & (...) | "defaultValue" | "notSelectable")[];
                      [key: string]: unknown;
                  };
                  projects?: number[];
                  projects2?: {
                      attributes?: ((...) | (...) | (...))[];
                      id?: number;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }
          • Optionalattributes?: (string & {} | "defaultValue" | "notSelectable")[]

            DEPRECATED

          • Optionalscope?: {
                global?: {
                    attributes?: ((...) & (...) | "defaultValue" | "notSelectable")[];
                    [key: string]: unknown;
                };
                projects?: number[];
                projects2?: {
                    attributes?: ((...) | (...) | (...))[];
                    id?: number;
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            }
            • Optionalglobal?: {
                  attributes?: ((...) & (...) | "defaultValue" | "notSelectable")[];
                  [key: string]: unknown;
              }
              • Optionalattributes?: ((...) & (...) | "defaultValue" | "notSelectable")[]

                Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.

            • Optionalprojects?: number[]

              DEPRECATED

            • Optionalprojects2?: { attributes?: ((...) | (...) | (...))[]; id?: number; [key: string]: unknown }[]

              Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.

        • 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: number

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

        • optionId: number

          The ID of the option to be updated.

        • Optionalproperties?: 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: string

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              config?: {
                  attributes?: (string & {} | "defaultValue" | "notSelectable")[];
                  scope?: {
                      global?: {
                          attributes?: ((...) | (...) | (...))[];
                          [key: string]: unknown;
                      };
                      projects?: number[];
                      projects2?: {
                          attributes?: (...)[];
                          id?: number;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              };
              id: number;
              properties?: Record<string, any>;
              value: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility