ElementTemplate GetNotificationRuleTemplates

Get notification rule templates for an element template

Request

GET elementtemplates/{webId}/notificationruletemplates

URL Parameters

• webId

  The ID of the element template. See WebID for more information.

• selectedFields

  List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields 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.

Status Codes

200: A list of notification rule templates.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg",
      "Id": "e9a984d0-f47c-11e7-8454-00155d029708",
      "Name": "MachineName",
      "Description": "Description entered by the user",
      "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\ElementTemplates[Template3]\\NotificationRuleTemplates[Notification Rule Template]",
      "CategoryNames": [
        "MachineNameAlerts"
      ],
      "Criteria": "Name: EventFrameCriteriaName",
      "MultiTriggerEventOption": "HighestSeverity",
      "NonrepetitionInterval": "PT3S",
      "ResendInterval": "PT5S",
      "Status": "Functioning",
      "TemplateName": "MachineName Notification Rule Template",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/notificationruletemplates/I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg"
      }
    },
    {
      "WebId": "I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg",
      "Id": "e9a984d0-f47c-11e7-8454-00155d029708",
      "Name": "MachineName",
      "Description": "Description entered by the user",
      "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\ElementTemplates[Template3]\\NotificationRuleTemplates[Notification Rule Template]",
      "CategoryNames": [
        "MachineNameAlerts"
      ],
      "Criteria": "Name: EventFrameCriteriaName",
      "MultiTriggerEventOption": "HighestSeverity",
      "NonrepetitionInterval": "PT3S",
      "ResendInterval": "PT5S",
      "Status": "Functioning",
      "TemplateName": "MachineName Notification Rule Template",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/notificationruletemplates/I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg"
      }
    }
  ],
  "Links": {}
}