Get Notification Template

Get Notification Template

Returns notification template for the specified id.

Request
URI
GET
https://{api_host}/suite-api/api/notifications/templates/{id}
COPY
Path Parameters
string
id
Required

Notification template identifier

Authentication
This operation uses the following authentication methods.
Responses
200

The notification template

Returns notification-template of type(s) application/json 
"{\n  \"templateId\" : \"23e10a37-ed94-4367-9897-b138fba97f83\",\n  \"pluginTypeId\" : \"WebhookPlugin\",\n  \"name\" : \"Template\",\n  \"description\" : \"WebhookPlugin Description\",\n  \"contentConfigs\" : [ {\n    \"baseResourceKindKeyStats\" : {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Resource kind\",\n        \"adapterKind\" : \"Adapter kind\"\n      },\n      \"stats\" : [ \"Property key\", \"Stat key\" ]\n    },\n    \"ancestorResourceKindKeys\" : [ {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Ancestor Resource kind\",\n        \"adapterKind\" : \"Ancestor Adapter kind\"\n      },\n      \"stats\" : [ \"Ancestor Stat Key\", \"Ancestor Property Key\" ]\n    } ],\n    \"descendantResourceKindKeys\" : [ {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Descendant Resource kind\",\n        \"adapterKind\" : \"Descendant Adapter kind\"\n      },\n      \"stats\" : [ \"Descendant Property Key\", \"Descendant Stat Key\" ]\n    } ]\n  } ],\n  \"formattingTemplate\" : {\n    \"type\" : \"WEBHOOK_TEMPLATE\",\n    \"newAlertTemplate\" : {\n      \"endpoint\" : \"/endpoint\",\n      \"headers\" : [ {\n        \"key\" : \"Content-type\",\n        \"value\" : \"application/json\"\n      }, {\n        \"key\" : \"Header Key\",\n        \"value\" : \"Header Value\"\n      } ],\n      \"method\" : \"POST\",\n      \"payload\" : \"{\\\"startDate\\\":\\\"${CREATE_TIME}\\\"}\"\n    }\n  },\n  \"templateType\" : \"ALERT\"\n}"
string
templateId
Optional

Notification template identifier

string
pluginTypeId
Required

Notification template type

string
name
Required

Name of the Notification template

string
description
Optional

Description of the Notification template

string
lastModifiedBy
Optional

Latest user UUID which modified the template

integer As int64 As int64
lastModifiedOn
Optional

Last time the template is modified

array of object
contentConfigs
Optional

A set of template content configs

object
formattingTemplate
Optional

Formatting template

array of object
templateProperties
Optional

Collection of template properties. Applicable only for WebhookPlugin and EmailPlugin.

integer As int32 As int32
attachedRuleCount
Optional

Attached rule count of the Notification template

boolean
editable
Optional

Indicates whether the template is editable or not

string
templateType
Optional

Notification Template Type

Possible values are : ALERT, ACTION, UNKNOWN,

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/notifications/templates/{id}
On This Page
Notifications Operations
GET
Get Notification Templates
PUT
Update Notification Template
POST
Create Notification Template
GET
Get All Notification Rules
PUT
Update Notification Plugin Rule
POST
Create Notification Plugin Rule
GET
Get Notification Template
DELETE
Delete Notification Template
GET
Get Notification Rule
DELETE
Delete Notification Plugin Rules