Function: getNotificationSchemes()

function getNotificationSchemes(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/issueNotificationSchemes.ts:23

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

Parameter	Type	Description
client	Client	-
parameters?	{ expand?: | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; id?: string[]; maxResults?: string; onlyDefault?: boolean; projectId?: string[]; startAt?: string; }	-
parameters.expand?	| "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "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
parameters.id?	string[]	The list of notification schemes IDs to be filtered by
parameters.maxResults?	string	The maximum number of items to return per page.
parameters.onlyDefault?	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.
parameters.projectId?	string[]	The list of projects IDs to be filtered by
parameters.startAt?	string	The index of the first item to return in a page of results (page offset).
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>