JIRA 7.6.1

Get project notification scheme

GET

/rest/api/3/project/{projectKeyOrId}/notificationscheme

Projects

Gets a notification scheme associated with the project.

Permissions required: Administer Jira global permission or Administer Projects project permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/project//notificationscheme'

Response Example

200 - Success

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

Request

Path Params

projectKeyOrId

string

required

The project ID or project key (case sensitive).

Query Params

expand

string

optional

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

Responses

🟢200Returned if the request is successful.

application/json

Body

Details about a notification scheme.

description

string

optional

The description of the notification scheme.

expand

string

optional

Expand options that include additional notification scheme details in the response.

integer <int64>

optional

The ID of the notification scheme.

name

string

optional

The name of the notification scheme.

notificationSchemeEvents

array[object (NotificationSchemeEvent) {2}]

optional

The notification events and associated recipients.

event

object (NotificationEvent)

optional

Details about a notification event.

notifications

array[object (EventNotification) {10}]

optional

projects

array[integer <int64>]

optional

The list of project IDs associated with the notification scheme.

scope

object

optional

The scope of the notification scheme.

project

object

read-onlyoptional

The project the item has scope in.

type

enum<string>

read-onlyoptional

The type of scope.

Allowed values:

PROJECTTEMPLATE

Additional properties

integer | number | string | boolean

optional

self

string

optional

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the project is not found or the user is not an administrator.

Modified at 2023-07-13 03:27:27

Get project issue type hierarchy

Get all project types