• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

notificationscheme

Postman Collection
OpenAPI
GET

Get paginated notification schemes

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.

Request

Query parameters

expand

string

maxResults

integer

startAt

integer

Responses

Paginated list of notification schemes to which the user has permissions.

application/json

PageBean
GET/api/2/notificationscheme
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/notificationscheme' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get full notification scheme details

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

    Path parameters

    id

    integer

    Required

    Query parameters

    expand

    string

    Responses

    Returns a full representation of the notification scheme with given id

    application/json

    NotificationSchemeBean
    GET/api/2/notificationscheme/{id}
    1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/notificationscheme/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

    Rate this page: