jira.js
    Preparing search index...

    Function getNotificationSchemes

    • Returns a paginated list of notification schemes ordered by the display name.

      Note that you should allow for events without recipients to appear in responses.

      Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

      Parameters

      • client: Client
      • Optionalparameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (
                    | "all"
                    | "user"
                    | "group"
                    | "field"
                    | string & {}
                    | "notificationSchemeEvents"
                    | "projectRole"
                )[];
            id?: string[];
            maxResults?: string;
            onlyDefault?: boolean;
            projectId?: string[];
            startAt?: string;
        }
        • Optionalexpand?:
              | string
              | string[]
              | string & {}
              | (
                  | "all"
                  | "user"
                  | "group"
                  | "field"
                  | string & {}
                  | "notificationSchemeEvents"
                  | "projectRole"
              )[]

          Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

          • all Returns all expandable information
          • field Returns information about any custom fields assigned to receive an event
          • group Returns information about any groups assigned to receive an event
          • notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
          • projectRole Returns information about any project roles assigned to receive an event
          • user Returns information about any users assigned to receive an event
        • Optionalid?: string[]

          The list of notification schemes IDs to be filtered by

        • OptionalmaxResults?: string

          The maximum number of items to return per page.

        • OptionalonlyDefault?: boolean

          When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false.

        • OptionalprojectId?: string[]

          The list of projects IDs to be filtered by

        • 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: {
                  description?: string;
                  expand?: string;
                  id?: number;
                  name?: string;
                  notificationSchemeEvents?: {
                      event?: NotificationEvent;
                      notifications?: {
                          emailAddress?: (...)
                          | (...);
                          expand?: (...) | (...);
                          field?: (...) | (...);
                          group?: (...) | (...);
                          id?: (...) | (...);
                          notificationType?:
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...)
                              | (...);
                          parameter?: (...) | (...);
                          projectRole?: (...) | (...);
                          recipient?: (...) | (...);
                          user?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  }[];
                  projects?: number[];
                  scope?: {
                      project?: {
                          avatarUrls?: {
                              "16x16"?: (...)
                              | (...);
                              "24x24"?: (...) | (...);
                              "32x32"?: (...) | (...);
                              "48x48"?: (...) | (...);
                              [key: string]: unknown;
                          };
                          id?: string;
                          key?: string;
                          name?: string;
                          projectCategory?: {
                              description?: (...)
                              | (...);
                              id?: (...) | (...);
                              name?: (...) | (...);
                              self?: (...) | (...);
                              [key: string]: unknown;
                          };
                          projectTypeKey?: | string & {}
                          | "software"
                          | "service_desk"
                          | "business"
                          | "product_discovery"
                          | "customer_service";
                          self?: string;
                          simplified?: boolean;
                          [key: string]: unknown;
                      };
                      type?: string & {}
                      | "PROJECT"
                      | "TEMPLATE";
                      [key: string]: unknown;
                  };
                  self?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility