NotificationRule GetNotificationRuleSubscribers

Retrieve notification rule subscribers.

Request

GET notificationrules/{webId}/notificationrulesubscribers

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 rule subscribers.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA",
      "Id": "e9a984d0-f47c-11e7-8454-00155d029708",
      "Name": "NotificationSubscriptionRuleName",
      "Description": "Manufacturing Machine MachineName subscription",
      "Path": "\\\\MyAssetServer\\MyDatabase\\NotificationRules[NotificationSubscriptionRuleName]",
      "ConfigString": "ToEmail=mike@testemail.com",
      "ContactTemplateName": "Plant Manager",
      "ContactType": "Individual",
      "DeliveryFormatName": "DeliveryFormat",
      "PlugInName": "Email",
      "EscalationTimeout": "PT3S",
      "MaximumRetries": "3",
      "NotifyOption": "EventStart",
      "RetryInterval": "PT3S",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/notificationrulesubscribers/I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA"
      }
    },
    {
      "WebId": "I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA",
      "Id": "e9a984d0-f47c-11e7-8454-00155d029708",
      "Name": "NotificationSubscriptionRuleName",
      "Description": "Manufacturing Machine MachineName subscription",
      "Path": "\\\\MyAssetServer\\MyDatabase\\NotificationRules[NotificationSubscriptionRuleName]",
      "ConfigString": "ToEmail=mike@testemail.com",
      "ContactTemplateName": "Plant Manager",
      "ContactType": "Individual",
      "DeliveryFormatName": "DeliveryFormat",
      "PlugInName": "Email",
      "EscalationTimeout": "PT3S",
      "MaximumRetries": "3",
      "NotifyOption": "EventStart",
      "RetryInterval": "PT3S",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/notificationrulesubscribers/I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA"
      }
    }
  ],
  "Links": {}
}