Availability
This routine is available starting with SIL Engine 4.8.0.8.
Syntax
admGetNotificationSchemeByName(notificationSchemeName)
Description
Retrieves a breakdown of events and notifications for a provided notification scheme.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
notificationSchemeName | string | Yes | The name of the notification scheme |
Return type
JGeneric[]
Returns an array of key/value pair representations of a notification scheme, where the key is the event name that triggers the notification and the value is a pipe (|) delimited list notification events.
If the notification has a designated parameter associated to the notification, then the parameter will be added to the end of the notification type separated by a dash.
Example: Group_Dropdown - jira-administrators
Example
string notificationSchemeName = "Default Notification Scheme";
JGeneric[] notifications = admGetNotificationSchemeByName(notificationSchemeName);
return notifications;
// JSON representation
/*
[{
"name": "Issue Created",
"value": "Remote_User|Group_Dropdown - jira-admin|Single_Email_Address - tim.reiking@cprime.com|User_Custom_Field_Value - customfield_12603|Group_Custom_Field_Value - customfield_10103|Project_Lead|Component_Lead|Single_User - treiking|Project_Role - 10100|Current_Assignee|Current_Reporter|All_Watchers"
}, {
"name": "Issue Assigned",
"value": "Current_Assignee|Current_Reporter|All_Watchers|Group_Dropdown - jira-administrators"
}, {
"name": "Issue Resolved",
"value": "Current_Assignee|Current_Reporter|All_Watchers"
}]
*/