Element GetNotificationRules

Retrieve notification rules for an element

Request

GET elements/{webId}/notificationrules

URL Parameters

• webId

  The ID of the resource to use as the root of the search. 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 rules.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag",
      "Id": "e9a984d0-f47c-11e7-8454-00155d029708",
      "Name": "MachineName",
      "Description": "Manufacturing Equipment MachineName",
      "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\EngineeringProcess\\Equipment\\MachineName\\NotificationRules[RuleName]",
      "AutoCreated": true,
      "CategoryNames": [
        "Equipment Assets"
      ],
      "Criteria": "Name: EventFrameCriteriaName",
      "MultiTriggerEventOption": "HighestSeverity",
      "NonrepetitionInterval": "PT3S",
      "ResendInterval": "PT5S",
      "Status": "Disabled",
      "TemplateName": "MachineName Notification Rule",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/notificationrules/I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag"
      }
    },
    {
      "WebId": "I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag",
      "Id": "e9a984d0-f47c-11e7-8454-00155d029708",
      "Name": "MachineName",
      "Description": "Manufacturing Equipment MachineName",
      "Path": "\\\\MyAssetServer\\MyDatabase\\CityName\\EngineeringProcess\\Equipment\\MachineName\\NotificationRules[RuleName]",
      "AutoCreated": true,
      "CategoryNames": [
        "Equipment Assets"
      ],
      "Criteria": "Name: EventFrameCriteriaName",
      "MultiTriggerEventOption": "HighestSeverity",
      "NonrepetitionInterval": "PT3S",
      "ResendInterval": "PT5S",
      "Status": "Disabled",
      "TemplateName": "MachineName Notification Rule",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/notificationrules/I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag"
      }
    }
  ],
  "Links": {}
}