org.everit.atlassian.restclient.jiracloud.v3.api

Class NotificationSchemeApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.NotificationSchemeApi

public class NotificationSchemeApi
extends Object

Constructor Summary

Constructors

Constructor and Description
NotificationSchemeApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<NotificationScheme>	getNotificationScheme(Long id, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get notification scheme Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.
io.reactivex.Single<PageBeanNotificationScheme>	getNotificationSchemes(Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get notification schemes paginated Returns a paginated list of notification schemes in order by display name.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationSchemeApi

public NotificationSchemeApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getNotificationScheme

public io.reactivex.Single<NotificationScheme> getNotificationScheme(Long id,
                                                                     Optional<String> expand,
                                                                     Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get notification scheme

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:

id -

The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.

(required)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<NotificationScheme>

getNotificationSchemes

public io.reactivex.Single<PageBeanNotificationScheme> getNotificationSchemes(Optional<Long> startAt,
                                                                              Optional<Integer> maxResults,
                                                                              Optional<String> expand,
                                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get notification schemes paginated

Returns a paginated list of notification schemes in order by display name.

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 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
  • AllWatchers
  • UserCustomField (the parameter is the ID of the custom field)
  • GroupCustomField(the parameter is the ID of the custom field)

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:

startAt -

The index of the first item to return in a page of results (page offset).

(optional, default to 0l)

maxResults -

The maximum number of items to return per page. The maximum is 50.

(optional, default to 50)

expand -

Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:

• 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.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PageBeanNotificationScheme>