Atlassian: Issue notification schemes schemas
14 Atlassian schemas with complete fields and constraints.
← Issue notification schemes operations · All schemas
Add notifications to notification scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of notifications which should be added to the notification scheme. Additional keys: allowed |
notificationSchemeEvents | array | Required within parent | The list of notifications which should be added to the notification scheme. write Only: true |
notificationSchemeEvents[] | Model | Each item | Expand Create notification scheme — request body — body notification Scheme Events item |
Referenced models: Create notification scheme — request body — body notification Scheme Events item
Create notification scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an notification scheme. Additional keys: allowed |
description | string | Optional | The description of the notification scheme. Maximum length: 4000 write Only: true |
name | string | Required within parent | The name of the notification scheme. Must be unique (case-insensitive). Maximum length: 255 write Only: true |
notificationSchemeEvents | array | Optional | The list of notifications which should be added to the notification scheme. write Only: true |
notificationSchemeEvents[] | Model | Each item | Expand Create notification scheme — request body — body notification Scheme Events item |
Referenced models: Create notification scheme — request body — body notification Scheme Events item
Create notification scheme — request body — body notification Scheme Events item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a notification scheme event. write Only: true Additional keys: allowed |
event | Model | Required within parent | Expand Create notification scheme — request body — body notification Scheme Events item event The ID of the event. |
notifications | array | Required within parent | The list of notifications mapped to a specified event. Maximum length: 255 write Only: true |
notifications[] | Model | Each item | Expand Create notification scheme — request body — body notification Scheme Events item notifications item |
Referenced models: Create notification scheme — request body — body notification Scheme Events item event, Create notification scheme — request body — body notification Scheme Events item notifications item
Create notification scheme — request body — body notification Scheme Events item event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of an event that is being mapped to notifications. write Only: true Additional keys: allowed |
id | string | Required within parent | The ID of the notification scheme event. write Only: true |
Create notification scheme — request body — body notification Scheme Events item notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a notification within a notification scheme. Maximum length: 255 write Only: true Additional keys: allowed |
notificationType | string | Required within parent | The notification type, e.g `CurrentAssignee`, `Group`, `EmailAddress`. write Only: true |
parameter | string | Optional | The value corresponding to the specified notification type. write Only: true |
Create notification scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of a notification scheme. Additional keys: allowed |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of a notification scheme. Read only: true |
id (anyOf 2) | null | Alternative |
Get notification scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a notification scheme. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the notification scheme. |
description (anyOf 2) | null | Alternative | |
expand | JSON | Optional | |
expand (anyOf 1) | string | Alternative | Expand options that include additional notification scheme details in the response. |
expand (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the notification scheme. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the notification scheme. |
name (anyOf 2) | null | Alternative | |
notificationSchemeEvents | JSON | Optional | |
notificationSchemeEvents (anyOf 1) | array | Alternative | The notification events and associated recipients. |
notificationSchemeEvents (anyOf 1)[] | Model | Each item | Expand Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item |
notificationSchemeEvents (anyOf 2) | null | Alternative | |
projects | JSON | Optional | |
projects (anyOf 1) | array | Alternative | The list of project IDs associated with the notification scheme. |
projects (anyOf 1)[] | JSON | Each item | |
projects (anyOf 1)[] (anyOf 1) | integer | Alternative | Format: int64 |
projects (anyOf 1)[] (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
projects (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Get status — response body — scope project, type The scope of the notification scheme. |
scope (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | |
self (anyOf 2) | null | Alternative |
Referenced models: Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item, Get status — response body — scope project, type
Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a notification scheme event. |
event | JSON | Optional | |
event (anyOf 1) | Model | Alternative | Expand Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item event Details about a notification event |
event (anyOf 2) | null | Alternative | |
notifications | JSON | Optional | |
notifications (anyOf 1) | array | Alternative | |
notifications (anyOf 1)[] | Model | Each item | Expand Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item notifications array item |
notifications (anyOf 2) | null | Alternative |
Referenced models: Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item notifications array item, Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item event Details about a notification event
Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item event Details about a notification event
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a notification event. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the event. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg). Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the event. |
name (anyOf 2) | null | Alternative | |
templateEvent | JSON | Optional | |
templateEvent (anyOf 1) | Model | Alternative | Expand Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item event Details about a notification event The template of the event. Only custom events configured by Jira administrators have template. |
templateEvent (anyOf 2) | null | Alternative |
Referenced models: Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item event Details about a notification event
Get notification scheme — response body — notification Scheme Events The notification events and associated recipients item notifications array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a notification associated with an event. |
emailAddress | JSON | Optional | |
emailAddress (anyOf 1) | string | Alternative | The email address. |
emailAddress (anyOf 2) | null | Alternative | |
expand | JSON | Optional | |
expand (anyOf 1) | string | Alternative | Expand options that include additional event notification details in the response. |
expand (anyOf 2) | null | Alternative | |
field | JSON | Optional | |
field (anyOf 1) | Model | Alternative | Expand Create custom field — response body The custom user or group field. |
field (anyOf 2) | null | Alternative | |
group | JSON | Optional | |
group (anyOf 1) | Model | Alternative | Expand Get user groups — response body — item The specified group. |
group (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the notification. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
notificationType | JSON | Optional | |
notificationType (anyOf 1) | string | Alternative | Identifies the recipients of the notification. Known values: CurrentAssignee, Reporter, CurrentUser, ProjectLead, ComponentLead, User, Group, ProjectRole, EmailAddress, AllWatchers, UserCustomField, GroupCustomField |
notificationType (anyOf 2) | null | Alternative | |
parameter | JSON | Optional | |
parameter (anyOf 1) | string | Alternative | As a group's name can change, use of `recipient` is recommended. The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by `notificationType` value. So, when `notificationType` is: * `User` The `parameter` is the user account ID. * `Group` The `parameter` is the group name. * `ProjectRole` The `parameter` is the project role ID. * `UserCustomField` The `parameter` is the ID of the custom field. * `GroupCustomField` The `parameter` is the ID of the custom field. |
parameter (anyOf 2) | null | Alternative | |
projectRole | JSON | Optional | |
projectRole (anyOf 1) | Model | Alternative | Expand Create project role — response body The specified project role. |
projectRole (anyOf 2) | null | Alternative | |
recipient | JSON | Optional | |
recipient (anyOf 1) | string | Alternative | The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by the `notificationType` value. So, when `notificationType` is: * `User`, `recipient` is the user account ID. * `Group`, `recipient` is the group ID. * `ProjectRole`, `recipient` is the project role ID. * `UserCustomField`, `recipient` is the ID of the custom field. * `GroupCustomField`, `recipient` is the ID of the custom field. |
recipient (anyOf 2) | null | Alternative | |
user | JSON | Optional | |
user (anyOf 1) | Model | Alternative | Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone The specified user. |
user (anyOf 2) | null | Alternative |
Referenced models: Create custom field — response body, Get user groups — response body — item, Create project role — response body, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone
Get notification schemes paginated — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get notification scheme — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get notification scheme — response body
Get projects using notification schemes paginated — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get projects using notification schemes paginated — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get projects using notification schemes paginated — response body — values The list of items item
Get projects using notification schemes paginated — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
notificationSchemeId | JSON | Optional | |
notificationSchemeId (anyOf 1) | string | Alternative | |
notificationSchemeId (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | |
projectId (anyOf 2) | null | Alternative |
Update notification scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a notification scheme. Additional keys: allowed |
description | string | Optional | The description of the notification scheme. Maximum length: 4000 write Only: true |
name | string | Optional | The name of the notification scheme. Must be unique. Maximum length: 255 write Only: true |