com.atlassian.jira.rest.v2.notification

Class NotificationSchemeResource

java.lang.Object

com.atlassian.jira.rest.v2.notification.NotificationSchemeResource

public class NotificationSchemeResource
extends Object

Constructor Summary

Constructors

Constructor and Description
NotificationSchemeResource(NotificationSchemeService notificationSchemeService, JiraAuthenticationContext authContext, ResponseFactory responseFactory, NotificationSchemeBeanFactory notificationSchemeBeanFactory)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getNotificationScheme(Long notificationSchemeId, String expand) Returns a full representation of the notification scheme for the given id.
javax.ws.rs.core.Response	getNotificationSchemes(Long startAt, Integer maxResults, String expand) Returns a paginated list of notification schemes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationSchemeResource

public NotificationSchemeResource(NotificationSchemeService notificationSchemeService,
                                  JiraAuthenticationContext authContext,
                                  ResponseFactory responseFactory,
                                  NotificationSchemeBeanFactory notificationSchemeBeanFactory)

Method Detail

getNotificationScheme

public javax.ws.rs.core.Response getNotificationScheme(Long notificationSchemeId,
                                                       String expand)

Returns a full representation of the notification scheme for the given id. This resource will return a notification scheme containing a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response. User accessing the data is required to have permissions to administer at least one project associated with the requested notification scheme.

Notification recipients can be:

• current assignee - the value of the notificationType is CurrentAssignee
• issue reporter - the value of the notificationType is Reporter
• current user - the value of the notificationType is CurrentUser
• project lead - the value of the notificationType is ProjectLead
• component lead - the value of the notificationType is ComponentLead
• all watchers - the value of the notification type is AllWatchers
• configured user - the value of the notification type is User. Parameter will contain key of the user. Information about the user will be provided if user expand parameter is used.
• configured group - the value of the notification type is Group. Parameter will contain name of the group. Information about the group will be provided if group expand parameter is used.
• configured email address - the value of the notification type is EmailAddress, additionally information about the email will be provided.
• users or users in groups in the configured custom fields - the value of the notification type is UserCustomField or GroupCustomField. Parameter will contain id of the custom field. Information about the field will be provided if field expand parameter is used.
• configured project role - the value of the notification type is ProjectRole. Parameter will contain project role id. Information about the project role will be provided if projectRole expand parameter is used.

Please see the example for reference.

The events can be JIRA system events or events configured by administrator. In case of the system events, data about theirs ids, names and descriptions is provided. In case of custom events, the template event is included as well.

Parameters:

notificationSchemeId - an id of the notification scheme to retrieve

expand: - optional information to be expanded in the response: group, user, projectRole or field.

Returns:

a full representation of the notification scheme with given id

getNotificationSchemes

public javax.ws.rs.core.Response getNotificationSchemes(Long startAt,
                                                        Integer maxResults,
                                                        String expand)

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:

startAt - the index of the first notification scheme to return (0 based).

maxResults - the maximum number of notification schemes to return (max 50).

expand: - optional information to be expanded in the response: group, user, projectRole or field.

Returns:

a paginated list of notification schemes to which the calling user has permissions.