Package com.atlassian.jira.rest.v2.notification

Class NotificationSchemeResource

java.lang.Object

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

@Path("notificationscheme")
@Consumes("application/json")
@Produces("application/json")
public class NotificationSchemeResource
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getNotificationScheme(Long notificationSchemeId, String expand)	Returns a full representation of the notification scheme for the given id.
jakarta.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 Details

NotificationSchemeResource

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

Method Details

getNotificationScheme

@GET
@Path("{id}")
public jakarta.ws.rs.core.Response getNotificationScheme(@PathParam("id")
 Long notificationSchemeId,
 @QueryParam("expand")
 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.

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

@GET
public jakarta.ws.rs.core.Response getNotificationSchemes(@QueryParam("startAt")
 Long startAt,
 @QueryParam("maxResults")
 Integer maxResults,
 @QueryParam("expand")
 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.