Interface NotificationSchemePayload

The payload for creating a notification scheme. The user has to supply the ID for the default notification scheme. For CMP this is provided in the project payload and should be left empty, for TMP it's provided using this payload

Example

CMP:"project": {
                 "pcri": "pcri:project:ref:new-project1",
                 "notificationSchemeId": "pcri:notificationScheme:id:10000",
                 ...
              }
TMP: "notification": {
       "pcri": "pcri:notificationScheme:ref:notification1",
       "name": "Simplified Notification Scheme",
       "notificationSchemeEvents": [
         {
           "event": {
             "id": "1"
           },
           "notifications": [
             {
               "notificationType": "CurrentAssignee"
             },
             {
               "notificationType": "Reporter"
             },
             {
               "notificationType": "AllWatchers"
             }
           ]
         },
         {
           "event": {
             "id": "2"
           },
           "notifications": [
             {
               "notificationType": "CurrentAssignee"
             },
             {
               "notificationType": "Reporter"
             },
             {
               "notificationType": "AllWatchers"
             }
           ]
         },...
       ]
     }
interface NotificationSchemePayload {
    description?: string;
    name?: string;
    notificationSchemeEvents?: NotificationSchemeEventPayload[];
    onConflict?: "USE" | "NEW" | "FAIL";
    pcri?: ProjectCreateResourceIdentifier;
}

Properties

description? name? notificationSchemeEvents? onConflict? pcri?

Properties

Optionaldescription

description?: string

The description of the notification scheme

Optionalname

name?: string

The name of the notification scheme

OptionalnotificationSchemeEvents

notificationSchemeEvents?: NotificationSchemeEventPayload[]

The events and notifications for the notification scheme

OptionalonConflict

onConflict?: "USE" | "NEW" | "FAIL"

The strategy to use when there is a conflict with an existing entity

Optionalpcri

pcri?: ProjectCreateResourceIdentifier

Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

Example

pcri:permissionScheme:id:10001

Settings

Member Visibility

On This Page

Properties