Get Notification Templates

Get Notification Templates

If the search criteria is not satisfied, the API will return all Notification Templates

Request
URI
GET
https://{api_host}/suite-api/api/notifications/templates
COPY
Query Parameters
string
name
Optional

Template name to search for

string
description
Optional

Template description to search for

string
outboundMethod
Optional

Attached outbound method of template to search for

string
modifiedBy
Optional

Template modified user name to search for

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page

Authentication
This operation uses the following authentication methods.
Responses
200

The collection of Alert Definitions

Returns notification-templates of type(s) application/json 
"{\n  \"notificationTemplates\" : [ {\n    \"templateId\" : \"88a9d16c-a8d4-44be-80f5-dd307f6aca25\",\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  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
notificationTemplates
Optional

List of notification templates


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/notifications/templates
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