Function: getNotificationSchemes()

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

Defined in: src/server/api/issueNotificationSchemes.ts:14

Returns a paginated list of notification schemes. In order to access notification scheme, the calling user is required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response. The list is ordered by the scheme's name. Follow the documentation of /notificationscheme/{id} resource for all details about returned value.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ expand?: string; maxResults?: number; startAt?: number; }	-
parameters.expand?	string	Optional information to be expanded in the response: group, user, projectRole or field.
parameters.maxResults?	number	The maximum number of notification schemes to return (max 50).
parameters.startAt?	number	The index of the first notification scheme to return (0 based).
options?	RequestOptions	-

Returns

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