jira.js
    Preparing search index...

    Function getSelectableIssueFieldOptions

    • Returns a paginated list of options for a select list issue field that can be viewed and selected by the user.

      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: Permission to access Jira.

      Parameters

      • client: Client
      • parameters: { fieldKey: string; maxResults?: number; projectId?: number; startAt?: number }
        • 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"
        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalprojectId?: number

          Filters the results to options that are only available in the specified project.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

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

    Settings
    Member Visibility