Class IssueNotificationSchemesService

This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes.

About notification schemes

A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the notificationSchemeEvents object and contains pairs of events and notifications:

event Identifies the type of event. The events can be Jira system events (see the Events section) or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress (deprecated)
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes

Hierarchy

CommonHttpService
- IssueNotificationSchemesService

Index

Constructors

constructor

Methods

addNotifications createNotificationScheme deleteNotificationScheme getNotificationScheme getNotificationSchemes getNotificationSchemeToProjectMappings removeNotificationFromNotificationScheme updateNotificationScheme initialize

Constructors

constructor

new IssueNotificationSchemesService(getClientInstance): IssueNotificationSchemesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueNotificationSchemesService
Inherited from CommonHttpService.constructor

Methods

addNotifications

addNotifications(params): Promise<void>
Adds notifications to a notification scheme. You can add up to 1000 notifications per request.

Deprecated: The notification type EmailAddress is no longer supported in Cloud. Refer to the changelog for more details.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  addNotificationsDetails: AddNotificationsDetails;
  id: string;
  }
  - addNotificationsDetails: AddNotificationsDetails
    Example
    { "notificationSchemeEvents": [ { "event": { "id": "1" }, "notifications": [ { "notificationType": "Group", "parameter": "jira-administrators" } ] } ] }
  - id: string
    The ID of the notification scheme.
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/notificationscheme/{id}/notification

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-notification-put

createNotificationScheme

createNotificationScheme(params): Promise<NotificationSchemeId>
Creates a notification scheme with notifications. You can create up to 1000 notifications per request.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  createNotificationSchemeDetails: CreateNotificationSchemeDetails;
  }
  - createNotificationSchemeDetails: CreateNotificationSchemeDetails
    Example
    { "description": "My new scheme description", "name": "My new notification scheme", "notificationSchemeEvents": [ { "event": { "id": "1" }, "notifications": [ { "notificationType": "Group", "parameter": "jira-administrators" } ] } ] }
Returns Promise<NotificationSchemeId>
Returned if the request is successful.

example:
```
{
  "id": "10001"
}
```
Path
POST /rest/api/3/notificationscheme

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-post

deleteNotificationScheme

deleteNotificationScheme(params): Promise<void>
Deletes a notification scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  notificationSchemeId: string;
  }
  - notificationSchemeId: string
    The ID of the notification scheme.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/notificationscheme/{notificationSchemeId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-delete

getNotificationScheme

getNotificationScheme(params): Promise<NotificationScheme>

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

params: {
expand?: string;
id: number;
}
- Optionalexpand?: string
  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.

Returns Promise<NotificationScheme>

Returned if the request is successful.

example:

{
  "description": "description",
  "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
  "id": 10100,
  "name": "notification scheme name",
  "notificationSchemeEvents": [
    {
      "event": {
        "description": "Event published when an issue is created",
        "id": 1,
        "name": "Issue created"
      },
      "notifications": [
        {
          "expand": "group",
          "group": {
            "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
            "name": "jira-administrators",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          },
          "id": 1,
          "notificationType": "Group",
          "parameter": "jira-administrators",
          "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
        },
        {
          "id": 2,
          "notificationType": "CurrentAssignee"
        },
        {
          "expand": "projectRole",
          "id": 3,
          "notificationType": "ProjectRole",
          "parameter": "10360",
          "projectRole": {
            "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
            "name": "Developers",
            "id": 10360,
            "description": "A project role that represents developers in a project",
            "actors": [
              {
                "actorGroup": {
                  "name": "jira-developers",
                  "displayName": "jira-developers",
                  "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
                },
                "displayName": "jira-developers",
                "id": 10240,
                "name": "jira-developers",
                "type": "atlassian-group-role-actor"
              },
              {
                "actorUser": {
                  "accountId": "5b10a2844c20165700ede21g"
                },
                "displayName": "Mia Krystof",
                "id": 10241,
                "type": "atlassian-user-role-actor"
              }
            ],
            "scope": {
              "project": {
                "id": "10000",
                "key": "KEY",
                "name": "Next Gen Project"
              },
              "type": "PROJECT"
            }
          },
          "recipient": "10360"
        },
        {
          "emailAddress": "rest-developer@atlassian.com",
          "id": 4,
          "notificationType": "EmailAddress",
          "parameter": "rest-developer@atlassian.com",
          "recipient": "rest-developer@atlassian.com"
        },
        {
          "expand": "user",
          "id": 5,
          "notificationType": "User",
          "parameter": "5b10a2844c20165700ede21g",
          "recipient": "5b10a2844c20165700ede21g",
          "user": {
            "accountId": "5b10a2844c20165700ede21g",
            "active": false,
            "displayName": "Mia Krystof",
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          }
        },
        {
          "expand": "field",
          "field": {
            "clauseNames": [
              "cf[10101]",
              "New custom field"
            ],
            "custom": true,
            "id": "customfield_10101",
            "key": "customfield_10101",
            "name": "New custom field",
            "navigable": true,
            "orderable": true,
            "schema": {
              "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
              "customId": 10101,
              "type": "project"
            },
            "searchable": true,
            "untranslatedName": "New custom field"
          },
          "id": 6,
          "notificationType": "GroupCustomField",
          "parameter": "customfield_10101",
          "recipient": "customfield_10101"
        }
      ]
    },
    {
      "event": {
        "description": "Custom event that is published together with an issue created event",
        "id": 20,
        "name": "Custom event",
        "templateEvent": {
          "description": "Event published when an issue is created",
          "id": 1,
          "name": "Issue created"
        }
      },
      "notifications": [
        {
          "expand": "group",
          "group": {
            "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
            "name": "jira-administrators",
            "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          },
          "id": 1,
          "notificationType": "Group",
          "parameter": "jira-administrators",
          "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
        },
        {
          "id": 2,
          "notificationType": "CurrentAssignee"
        },
        {
          "expand": "projectRole",
          "id": 3,
          "notificationType": "ProjectRole",
          "parameter": "10360",
          "projectRole": {
            "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
            "name": "Developers",
            "id": 10360,
            "description": "A project role that represents developers in a project",
            "actors": [
              {
                "actorGroup": {
                  "name": "jira-developers",
                  "displayName": "jira-developers",
                  "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
                },
                "displayName": "jira-developers",
                "id": 10240,
                "name": "jira-developers",
                "type": "atlassian-group-role-actor"
              },
              {
                "actorUser": {
                  "accountId": "5b10a2844c20165700ede21g"
                },
                "displayName": "Mia Krystof",
                "id": 10241,
                "type": "atlassian-user-role-actor"
              }
            ],
            "scope": {
              "project": {
                "id": "10000",
                "key": "KEY",
                "name": "Next Gen Project"
              },
              "type": "PROJECT"
            }
          },
          "recipient": "10360"
        },
        {
          "emailAddress": "rest-developer@atlassian.com",
          "id": 4,
          "notificationType": "EmailAddress",
          "parameter": "rest-developer@atlassian.com",
          "recipient": "rest-developer@atlassian.com"
        },
        {
          "expand": "user",
          "id": 5,
          "notificationType": "User",
          "parameter": "5b10a2844c20165700ede21g",
          "recipient": "5b10a2844c20165700ede21g",
          "user": {
            "accountId": "5b10a2844c20165700ede21g",
            "active": false,
            "displayName": "Mia Krystof",
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          }
        },
        {
          "expand": "field",
          "field": {
            "clauseNames": [
              "cf[10101]",
              "New custom field"
            ],
            "custom": true,
            "id": "customfield_10101",
            "key": "customfield_10101",
            "name": "New custom field",
            "navigable": true,
            "orderable": true,
            "schema": {
              "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
              "customId": 10101,
              "type": "project"
            },
            "searchable": true,
            "untranslatedName": "New custom field"
          },
          "id": 6,
          "notificationType": "GroupCustomField",
          "parameter": "customfield_10101",
          "recipient": "customfield_10101"
        }
      ]
    }
  ],
  "projects": [
    10001,
    10002
  ],
  "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
}

Path

GET /rest/api/3/notificationscheme/{id} @scopes-current manage:jira-configuration @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira, read:field-configuration:jira, read:group:jira, read:project-category:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-get

getNotificationSchemes

getNotificationSchemes(params?): Promise<PageBeanNotificationScheme>

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

params: {
    expand?: string;
    id?: string[];
    maxResults?: string;
    onlyDefault?: boolean;
    projectId?: string[];
    startAt?: string;
} = {}
- Optionalexpand?: string
  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
- Optionalid?: string[]
  The list of notification schemes IDs to be filtered by
- OptionalmaxResults?: string
  The maximum number of items to return per page.
- OptionalonlyDefault?: 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.
- OptionalprojectId?: string[]
  The list of projects IDs to be filtered by
- OptionalstartAt?: string
  The index of the first item to return in a page of results (page offset).

Returns Promise<PageBeanNotificationScheme>

Returned if the request is successful. Only returns notification schemes that the user has permission to access. An empty list is returned if the user lacks permission to access all notification schemes.

example:

{
  "isLast": false,
  "maxResults": 6,
  "startAt": 1,
  "total": 5,
  "values": [
    {
      "description": "description",
      "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
      "id": 10100,
      "name": "notification scheme name",
      "notificationSchemeEvents": [
        {
          "event": {
            "description": "Event published when an issue is created",
            "id": 1,
            "name": "Issue created"
          },
          "notifications": [
            {
              "expand": "group",
              "group": {
                "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
                "name": "jira-administrators",
                "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
              },
              "id": 1,
              "notificationType": "Group",
              "parameter": "jira-administrators",
              "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
            },
            {
              "id": 2,
              "notificationType": "CurrentAssignee"
            },
            {
              "expand": "projectRole",
              "id": 3,
              "notificationType": "ProjectRole",
              "parameter": "10360",
              "projectRole": {
                "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
                "name": "Developers",
                "id": 10360,
                "description": "A project role that represents developers in a project",
                "actors": [
                  {
                    "actorGroup": {
                      "name": "jira-developers",
                      "displayName": "jira-developers",
                      "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
                    },
                    "displayName": "jira-developers",
                    "id": 10240,
                    "name": "jira-developers",
                    "type": "atlassian-group-role-actor"
                  },
                  {
                    "actorUser": {
                      "accountId": "5b10a2844c20165700ede21g"
                    },
                    "displayName": "Mia Krystof",
                    "id": 10241,
                    "type": "atlassian-user-role-actor"
                  }
                ],
                "scope": {
                  "project": {
                    "id": "10000",
                    "key": "KEY",
                    "name": "Next Gen Project"
                  },
                  "type": "PROJECT"
                }
              },
              "recipient": "10360"
            },
            {
              "emailAddress": "rest-developer@atlassian.com",
              "id": 4,
              "notificationType": "EmailAddress",
              "parameter": "rest-developer@atlassian.com",
              "recipient": "rest-developer@atlassian.com"
            },
            {
              "expand": "user",
              "id": 5,
              "notificationType": "User",
              "parameter": "5b10a2844c20165700ede21g",
              "recipient": "5b10a2844c20165700ede21g",
              "user": {
                "accountId": "5b10a2844c20165700ede21g",
                "active": false,
                "displayName": "Mia Krystof",
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
              }
            },
            {
              "expand": "field",
              "field": {
                "clauseNames": [
                  "cf[10101]",
                  "New custom field"
                ],
                "custom": true,
                "id": "customfield_10101",
                "key": "customfield_10101",
                "name": "New custom field",
                "navigable": true,
                "orderable": true,
                "schema": {
                  "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
                  "customId": 10101,
                  "type": "project"
                },
                "searchable": true,
                "untranslatedName": "New custom field"
              },
              "id": 6,
              "notificationType": "GroupCustomField",
              "parameter": "customfield_10101",
              "recipient": "customfield_10101"
            }
          ]
        },
        {
          "event": {
            "description": "Custom event that is published together with an issue created event",
            "id": 20,
            "name": "Custom event",
            "templateEvent": {
              "description": "Event published when an issue is created",
              "id": 1,
              "name": "Issue created"
            }
          },
          "notifications": [
            {
              "expand": "group",
              "group": {
                "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
                "name": "jira-administrators",
                "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
              },
              "id": 1,
              "notificationType": "Group",
              "parameter": "jira-administrators",
              "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
            },
            {
              "id": 2,
              "notificationType": "CurrentAssignee"
            },
            {
              "expand": "projectRole",
              "id": 3,
              "notificationType": "ProjectRole",
              "parameter": "10360",
              "projectRole": {
                "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
                "name": "Developers",
                "id": 10360,
                "description": "A project role that represents developers in a project",
                "actors": [
                  {
                    "actorGroup": {
                      "name": "jira-developers",
                      "displayName": "jira-developers",
                      "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
                    },
                    "displayName": "jira-developers",
                    "id": 10240,
                    "name": "jira-developers",
                    "type": "atlassian-group-role-actor"
                  },
                  {
                    "actorUser": {
                      "accountId": "5b10a2844c20165700ede21g"
                    },
                    "displayName": "Mia Krystof",
                    "id": 10241,
                    "type": "atlassian-user-role-actor"
                  }
                ],
                "scope": {
                  "project": {
                    "id": "10000",
                    "key": "KEY",
                    "name": "Next Gen Project"
                  },
                  "type": "PROJECT"
                }
              },
              "recipient": "10360"
            },
            {
              "emailAddress": "rest-developer@atlassian.com",
              "id": 4,
              "notificationType": "EmailAddress",
              "parameter": "rest-developer@atlassian.com",
              "recipient": "rest-developer@atlassian.com"
            },
            {
              "expand": "user",
              "id": 5,
              "notificationType": "User",
              "parameter": "5b10a2844c20165700ede21g",
              "recipient": "5b10a2844c20165700ede21g",
              "user": {
                "accountId": "5b10a2844c20165700ede21g",
                "active": false,
                "displayName": "Mia Krystof",
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
              }
            },
            {
              "expand": "field",
              "field": {
                "clauseNames": [
                  "cf[10101]",
                  "New custom field"
                ],
                "custom": true,
                "id": "customfield_10101",
                "key": "customfield_10101",
                "name": "New custom field",
                "navigable": true,
                "orderable": true,
                "schema": {
                  "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
                  "customId": 10101,
                  "type": "project"
                },
                "searchable": true,
                "untranslatedName": "New custom field"
              },
              "id": 6,
              "notificationType": "GroupCustomField",
              "parameter": "customfield_10101",
              "recipient": "customfield_10101"
            }
          ]
        }
      ],
      "projects": [
        10001,
        10002
      ],
      "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
    }
  ]
}

Path

GET /rest/api/3/notificationscheme @scopes-current manage:jira-configuration @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira, read:group:jira, read:project-category:jira, read:field-configuration:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-get

getNotificationSchemeToProjectMappings

getNotificationSchemeToProjectMappings(params?): Promise<PageBeanNotificationSchemeAndProjectMappingJsonBean>
Returns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.

Permissions required: Permission to access Jira.
Parameters
- params: {
      maxResults?: string;
      notificationSchemeId?: string[];
      projectId?: string[];
      startAt?: string;
  } = {}
  - OptionalmaxResults?: string
    The maximum number of items to return per page.
  - OptionalnotificationSchemeId?: string[]
    The list of notifications scheme IDs to be filtered out
  - OptionalprojectId?: string[]
    The list of project IDs to be filtered out
  - OptionalstartAt?: string
    The index of the first item to return in a page of results (page offset).
Returns Promise<PageBeanNotificationSchemeAndProjectMappingJsonBean>
Returned if the request is successful.

example:
```
{
  "isLast": true,
  "maxResults": 50,
  "startAt": 0,
  "total": 4,
  "values": [
    {
      "notificationSchemeId": "10001",
      "projectId": "100001"
    }
  ]
}
```
Path
GET /rest/api/3/notificationscheme/project @scopes-current manage:jira-configuration @scopes-beta read:notification-scheme:jira, read:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-project-get

removeNotificationFromNotificationScheme

removeNotificationFromNotificationScheme(params): Promise<void>
Removes a notification from a notification scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  notificationId: string;
  notificationSchemeId: string;
  }
  - notificationId: string
    The ID of the notification.
  - notificationSchemeId: string
    The ID of the notification scheme.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-notification-notificationid-delete

updateNotificationScheme

updateNotificationScheme(params): Promise<void>
Updates a notification scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: string;
  updateNotificationSchemeDetails: UpdateNotificationSchemeDetails;
  }
  - id: string
    The ID of the notification scheme.
  - updateNotificationSchemeDetails: UpdateNotificationSchemeDetails
    Example
    { "description": "My updated notification scheme description", "name": "My updated notification scheme" }
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/notificationscheme/{id}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueNotificationSchemesService

About notification schemes

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueNotificationSchemesService

Methods

addNotifications

Parameters

addNotificationsDetails: AddNotificationsDetails

Example

id: string

Returns Promise<void>

Path

See

createNotificationScheme

Parameters

createNotificationSchemeDetails: CreateNotificationSchemeDetails

Example

Returns Promise<NotificationSchemeId>

Path

See

deleteNotificationScheme

Parameters

notificationSchemeId: string

Returns Promise<void>

Path

See

getNotificationScheme

Parameters

Optionalexpand?: string

id: number

Returns Promise<NotificationScheme>

Path

See

getNotificationSchemes

Parameters

Optionalexpand?: string

Optionalid?: string[]

OptionalmaxResults?: string

OptionalonlyDefault?: boolean

OptionalprojectId?: string[]

OptionalstartAt?: string

Returns Promise<PageBeanNotificationScheme>

Path

See

getNotificationSchemeToProjectMappings

Parameters

OptionalmaxResults?: string

OptionalnotificationSchemeId?: string[]

OptionalprojectId?: string[]

OptionalstartAt?: string

Returns Promise<PageBeanNotificationSchemeAndProjectMappingJsonBean>

Path

See

removeNotificationFromNotificationScheme

Parameters

notificationId: string

notificationSchemeId: string

Returns Promise<void>

Path

See

updateNotificationScheme

Parameters

id: string

updateNotificationSchemeDetails: UpdateNotificationSchemeDetails

Example

Returns Promise<void>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`expand?: string

`Optional`expand?: string

`Optional`id?: string[]

`Optional`maxResults?: string

`Optional`onlyDefault?: boolean

`Optional`projectId?: string[]

`Optional`startAt?: string

`Optional`maxResults?: string

`Optional`notificationSchemeId?: string[]

`Optional`projectId?: string[]

`Optional`startAt?: string

`Protected` `Static`initialize