Function: getNotificationSchemeForProject()
function getNotificationSchemeForProject(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
description?: string;
expand?: string;
id?: number;
name?: string;
notificationSchemeEvents?: object[];
projects?: number[];
scope?: {
[key: string]: unknown;
project?: {
[key: string]: unknown;
avatarUrls?: {
[key: string]: unknown;
16x16?: string;
24x24?: string;
32x32?: string;
48x48?: string;
};
id?: string;
key?: string;
name?: string;
projectCategory?: {
[key: string]: unknown;
description?: string;
id?: string;
name?: string;
self?: string;
};
projectTypeKey?: | string & object
| "software"
| "service_desk"
| "business"
| "product_discovery"
| "customer_service";
self?: string;
simplified?: boolean;
};
type?: string & object | "PROJECT" | "TEMPLATE";
};
self?: string;
}>;Defined in: src/cloud/api/projects.ts:294
Gets a notification scheme associated with the project.
Permissions required:Administer Jira global permission or Administer Projects project permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { expand?: | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole" | ( | "all" | "user" | "group" | "field" | string & object | "notificationSchemeEvents" | "projectRole")[]; projectKeyOrId: 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.projectKeyOrId? | string | The project ID or project key (case sensitive). |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; notificationSchemeEvents?: object[]; projects?: number[]; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; id?: string; key?: string; name?: string; projectCategory?: { [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; }>