jira.js
    Preparing search index...

    Function getNotificationScheme

    • Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

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

      Parameters

      • client: Client
      • parameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | (
                    | "all"
                    | "user"
                    | "group"
                    | "field"
                    | string & {}
                    | "notificationSchemeEvents"
                    | "projectRole"
                )[];
            id: number;
        }
        • 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
        • id: number

          The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              description?: string;
              expand?: string;
              id?: number;
              name?: string;
              notificationSchemeEvents?: {
                  event?: NotificationEvent;
                  notifications?: {
                      emailAddress?: string;
                      expand?: string;
                      field?: {
                          clauseNames?: (...)
                          | (...);
                          custom?: (...) | (...) | (...);
                          id?: (...) | (...);
                          key?: (...) | (...);
                          name?: (...) | (...);
                          navigable?: (...) | (...) | (...);
                          orderable?: (...) | (...) | (...);
                          schema?: (...) | (...);
                          scope?: (...) | (...);
                          searchable?: (...) | (...) | (...);
                          untranslatedName?: (...) | (...);
                          [key: string]: unknown;
                      };
                      group?: {
                          groupId?: (...)
                          | (...)
                          | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      };
                      id?: number;
                      notificationType?: | string & {}
                      | "Group"
                      | "CurrentAssignee"
                      | "Reporter"
                      | "CurrentUser"
                      | "ProjectLead"
                      | "ComponentLead"
                      | "User"
                      | "ProjectRole"
                      | "EmailAddress"
                      | "AllWatchers"
                      | "UserCustomField"
                      | "GroupCustomField";
                      parameter?: string;
                      projectRole?: {
                          actors?: (...)
                          | (...);
                          admin?: (...) | (...) | (...);
                          currentUserRole?: (...) | (...) | (...);
                          default?: (...) | (...) | (...);
                          description?: (...) | (...);
                          id?: (...) | (...);
                          name?: (...) | (...);
                          roleConfigurable?: (...) | (...) | (...);
                          scope?: (...) | (...);
                          self?: (...) | (...);
                          translatedName?: (...) | (...);
                          [key: string]: unknown;
                      };
                      recipient?: string;
                      user?: {
                          accountId?: (...)
                          | (...);
                          accountType?: (...) | (...);
                          active?: (...) | (...) | (...);
                          avatarUrls?: (...) | (...);
                          displayName?: (...) | (...);
                          emailAddress?: (...) | (...);
                          self?: (...) | (...);
                          timeZone?: (...) | (...);
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              }[];
              projects?: number[];
              scope?: {
                  project?: {
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      id?: string;
                      key?: string;
                      name?: string;
                      projectCategory?: {
                          description?: string;
                          id?: string;
                          name?: string;
                          self?: string;
                          [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;
          },
      >

    Settings
    Member Visibility