jira.js
    Preparing search index...

    Function searchPriorities

    • Returns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:

      • A list of priority IDs. Any invalid priority IDs are ignored.
      • A list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.
      • Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.

      Deprecation notice: The onlyDefault parameter is deprecated and will be removed at a later date. See CHANGE-1655.

      Deprecation notice: The isDefault property of priorities is deprecated and will be removed at a later date. See CHANGE-1655.

      Permissions required: Permission to access Jira.

      Parameters

      • client: Client
      • Optionalparameters: {
            expand?: string;
            id?: string[];
            maxResults?: string;
            onlyDefault?: boolean;
            priorityName?: string;
            projectId?: string[];
            startAt?: string;
        }
        • Optionalexpand?: string

          Use schemes to return the associated priority schemes for each priority. Limited to returning first 15 priority schemes per priority.

        • Optionalid?: string[]

          The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3.

        • OptionalmaxResults?: string

          The maximum number of items to return per page.

        • OptionalonlyDefault?: boolean

          Whether only the default priority is returned.

        • OptionalpriorityName?: string

          The name of priority to search for.

        • OptionalprojectId?: string[]

          The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&projectId=10111.

        • OptionalstartAt?: string

          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: {
                  avatarId?: number;
                  description?: string;
                  iconUrl?: string;
                  id?: string;
                  isDefault?: boolean;
                  name?: string;
                  schemes?: {
                      maxResults?: number;
                      startAt?: number;
                      total?: number;
                      [key: string]: unknown;
                  };
                  self?: string;
                  statusColor?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility