Atlassian · Schema

NotificationScheme

Details about a notification scheme.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the notification scheme.
expand string Expand options that include additional notification scheme details in the response.
id integer The ID of the notification scheme.
name string The name of the notification scheme.
notificationSchemeEvents array The notification events and associated recipients.
projects array The list of project IDs associated with the notification scheme.
scope object The scope of the notification scheme.
self string
View JSON Schema on GitHub

JSON Schema

atlassian-notificationscheme-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NotificationScheme",
  "title": "NotificationScheme",
  "additionalProperties": false,
  "description": "Details about a notification scheme.",
  "properties": {
    "description": {
      "description": "The description of the notification scheme.",
      "type": "string"
    },
    "expand": {
      "description": "Expand options that include additional notification scheme details in the response.",
      "type": "string"
    },
    "id": {
      "description": "The ID of the notification scheme.",
      "format": "int64",
      "type": "integer"
    },
    "name": {
      "description": "The name of the notification scheme.",
      "type": "string"
    },
    "notificationSchemeEvents": {
      "description": "The notification events and associated recipients.",
      "items": {
        "$ref": "#/components/schemas/NotificationSchemeEvent"
      },
      "type": "array"
    },
    "projects": {
      "description": "The list of project IDs associated with the notification scheme.",
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "type": "array"
    },
    "scope": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Scope"
        }
      ],
      "description": "The scope of the notification scheme."
    },
    "self": {
      "type": "string"
    }
  },
  "type": "object"
}