Notification

Manage self notifications with the Notification Service API.

@dynatrace-sdk/client-notification

v2.0.1

npm install @dynatrace-sdk/client-notification

selfNotificationsClient

import { selfNotificationsClient } from '@dynatrace-sdk/client-notification';

createSelfNotification

selfNotificationsClient.createSelfNotification(config): Promise<SelfNotification>

Required scope: notification:self-notifications:write

Parameters

Name	Type
config.body*required	SelfNotificationCreate

Returns

Return type	Status code	Description
SelfNotification	201

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { selfNotificationsClient } from "@dynatrace-sdk/client-notification";

const data =
  await selfNotificationsClient.createSelfNotification({
    body: {
      resourceId: "...",
      notificationType: "...",
      triggerConfiguration: {
        type: EventQueryTriggerConfigType.Event,
        value: { query: "..." },
      },
    },
  });

deleteSelfNotification

selfNotificationsClient.deleteSelfNotification(config): Promise<void>

Required scope: notification:self-notifications:write

Parameters

Name	Type	Description
config.id*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
void	204	No response body

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { selfNotificationsClient } from "@dynatrace-sdk/client-notification";

const data =
  await selfNotificationsClient.deleteSelfNotification({
    id: "...",
  });

getSelfNotification

selfNotificationsClient.getSelfNotification(config): Promise<SelfNotification>

Required scope: notification:self-notifications:read

Parameters

Name	Type	Description
config.id*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
SelfNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { selfNotificationsClient } from "@dynatrace-sdk/client-notification";

const data =
  await selfNotificationsClient.getSelfNotification({
    id: "...",
  });

getSelfNotifications

selfNotificationsClient.getSelfNotifications(config): Promise<PaginatedSelfNotificationList>

Required scope: notification:self-notifications:read

Parameters

Name	Type	Description
config.appId	string
config.limit	number	Number of results to return per page.
config.notificationType	string
config.offset	number	The initial index from which to return the results.
config.ordering	string	Which field to use when ordering the results.
config.owner	string
config.resourceId	string
config.search	string	A search term.

Returns

Return type	Status code	Description
PaginatedSelfNotificationList	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { selfNotificationsClient } from "@dynatrace-sdk/client-notification";

const data =
  await selfNotificationsClient.getSelfNotifications();

patchSelfNotification

selfNotificationsClient.patchSelfNotification(config): Promise<SelfNotification>

Required scope: notification:self-notifications:write

Parameters

Name	Type	Description
config.body*required	SelfNotificationUpdate
config.id*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
SelfNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { selfNotificationsClient } from "@dynatrace-sdk/client-notification";

const data =
  await selfNotificationsClient.patchSelfNotification({
    id: "...",
    body: {
      triggerConfiguration: {
        type: EventQueryTriggerConfigType.Event,
        value: { query: "..." },
      },
    },
  });

updateSelfNotification

selfNotificationsClient.updateSelfNotification(config): Promise<SelfNotification>

Required scope: notification:self-notifications:write

Parameters

Name	Type	Description
config.body*required	SelfNotificationUpdate
config.id*required	string	A UUID string identifying this self notification.

Returns

Return type	Status code	Description
SelfNotification	200

Throws

Error Type	Error Message
ErrorEnvelopeError

Code example

import { selfNotificationsClient } from "@dynatrace-sdk/client-notification";

const data =
  await selfNotificationsClient.updateSelfNotification({
    id: "...",
    body: {
      triggerConfiguration: {
        type: EventQueryTriggerConfigType.Event,
        value: { query: "..." },
      },
    },
  });

Types

DavisEventConfig

Name	Type	Description
customFilter	string	Additional DQL matcher expression to further filter events to match.
entityTags	EntityTags	Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}
entityTagsMatch	"all" | "any"	Event must match all or any of the entity tags.
names	Array<DavisEventName>
onProblemClose	boolean	Trigger on Davis event open only or also on close. default: false
typesDEPRECATED	Array<string>

DavisEventName

Name	Type	Description
match*required	"equals" | "contains"	Davis event name must equal or contain the string provided.
name*required	string

DavisEventTriggerConfig

Name	Type
type*required	"davis-event"
value*required	DavisEventConfig

DavisProblemCategories

Name	Type
availability	boolean
custom	boolean
error	boolean
info	boolean
monitoringUnavailable	boolean
resource	boolean
slowdown	boolean

DavisProblemConfig

Name	Type	Description
categories*required	DavisProblemCategories
customFilter	string	Additional DQL matcher expression to further filter events to match.
entityTags	EntityTags	Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}
entityTagsMatch	"all" | "any"	Event must match all or any of the entity tags.
onProblemClose	boolean	Trigger on Davis problem open only or also on close. default: false

DavisProblemTriggerConfig

Name	Type
type*required	"davis-problem"
value*required	DavisProblemConfig

EntityTags

Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}

type: Record<string, string | string[] | undefined>

Error

Name	Type
code*required	number
details	ErrorDetails
message*required	string

ErrorDetails

type: Record<string, any>

ErrorEnvelope

Name	Type
error*required	Error

EventQuery

Name	Type	Description
eventType	"events" | "bizevents" | "dt.system.events"	Grail event type.
query*required	string	DQL matcher expression defining which events to match.

EventQueryTriggerConfig

Name	Type
type*required	"event"
value*required	EventQuery

ModificationInfo

Name	Type
createdBy*required	null | string
createdTime*required	Date
lastModifiedBy*required	null | string
lastModifiedTime*required	Date

PaginatedSelfNotificationList

Name	Type
count*required	number
results*required	Array<SelfNotification>

SelfNotification

Name	Type	Description
appId	string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
id*required	string
input	SelfNotificationInput	SelfNotificationInput object consisting of subject and content. Supports automation expressions https://dt-url.net/workflows-expression-reference and markdown syntax. A template provided with an app ({notification_type}.notification-template.json) will take precedence over the input provided here.
modificationInfo*required	ModificationInfo
notificationType*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
owner*required	string
resourceId*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
title	string
triggerConfiguration*required	EventTriggerConfig

SelfNotificationCreate

Name	Type	Description
appId	string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
id	string
input	SelfNotificationInput	SelfNotificationInput object consisting of subject and content. Supports automation expressions https://dt-url.net/workflows-expression-reference and markdown syntax. A template provided with an app ({notification_type}.notification-template.json) will take precedence over the input provided here.
notificationType*required	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
resourceId*required	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
title	string
triggerConfiguration*required	EventTriggerConfig

SelfNotificationInput

Name	Type
content	string
subject	string

SelfNotificationUpdate

Name	Type	Description
appId	string	App id for registered notification. Optional, by default automatically inferred from the request. Only relevant for manual testing purposes via swagger.
input	SelfNotificationInput	SelfNotificationInput object consisting of subject and content. Supports automation expressions https://dt-url.net/workflows-expression-reference and markdown syntax. A template provided with an app ({notification_type}.notification-template.json) will take precedence over the input provided here.
notificationType	string	String that defines the type of a notification in context of an app. Allows to differentiate between multiple types of notifications in context of one app.
resourceId	string	Unique identifier of resource to notify on. Used to determine if there is a notification registered for a resource in context of the app and notification type for a user.
title	string
triggerConfiguration*required	EventTriggerConfig

Enums

DavisEventNameMatch

Davis event name must equal or contain the string provided.

Enum keys

Contains | Equals

DavisEventTriggerConfigType

Enum keys

DavisEvent

DavisProblemTriggerConfigType

Enum keys

DavisProblem

EntityTagsMatch

Event must match all or any of the entity tags.

Enum keys

All | Any

EventQueryTriggerConfigType

Enum keys

Event

EventType

Grail event type.

Enum keys

Bizevents | DtSystemEvents | Events