NotificationRuleTemplate CreateNotificationRuleTemplateSubscriber
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
NotificationRuleTemplate CreateNotificationRuleTemplateSubscriber
Create a notification rule subscriber.
Request
POST notificationruletemplates/{webId}/notificationrulesubscribers
URL Parameters
-
webId The ID of the notification rule template on which to create the notification rule subscriber. See WebID for more information.
-
webIdType Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.
Body Parameter
The new notification rule subscriber definition.
Status Codes
201: The notification rule subscriber was created. The response's Location header is a link to the notification rule subscriber.
Sample Request Body
{
"ConfigString": "ToEmail=mike@testemail.com",
"ContactTemplateName": "Plant Manager",
"EscalationTimeout": "PT3S",
"MaximumRetries": "3",
"NotifyOption": "EventStart",
"RetryInterval": "PT3S"
}