Atlassian: Get notification scheme

Atlassian issueNotificationSchemes.getNotificationScheme: arguments, response, policy and SDK examples.

← Issue notification schemes operations · Get started

Operation atlassian.getnotificationscheme

Provider route: GET /{cloudId}/rest/api/3/notificationscheme/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issueNotificationSchemes"]["getNotificationScheme"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issueNotificationSchemes.getNotificationScheme(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issue_notification_schemes.get_notification_scheme(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`path.id`	integer	Required within parent	Format: int64
`query`	object	Optional	Additional keys: not allowed
`query.expand`	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Get notification scheme — response body

Referenced models: Get notification scheme — response body

Schemas

12 more schemas are linked from the tables above, on the schema pages.

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 status — response body — scope project, type

Field	Type	Presence	Description and constraints
`$`	object	Root	The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Get issue type screen scheme projects — response body — values The list of items item The project the item has scope in. Read only: true
`project (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of scope. Known values: PROJECT, TEMPLATE Read only: true
`type (anyOf 2)`	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items item

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

Policy, approvals and errors

SDK function policy ID: atlassian.getnotificationscheme. Catalog operation: getnotificationscheme. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source

Report an issue with this page