NotificationPlugIn Get
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
NotificationPlugIn Get
Retrieve a notification plugin.
Request
GET notificationplugins/{webId}
URL Parameters
-
webId The ID of the notification plugin. 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: The specified notification plugin.
Sample Response Body
{
"WebId": "F1DCDqD5loBNH0erqeqJodtALA1jVcFNf02UGGrgjlCY06lgUkVTVFVOSVRcUExVR0lOU0RFTElWRVJZQ0hBTk5FTFtXRUJTRVJWSUNFXQ",
"Id": "145c35d6-f4d7-41d9-86ae-08e5098d3a96",
"Name": "WebService",
"Description": "Delivery channel for calling a web service",
"Path": "\\\\MyAssetServer\\PlugInsDeliveryChannel[WebService]",
"AssemblyFileName": "OSIsoft.AF.Notification.DeliveryChannel.WebService.dll",
"AssemblyID": "0b450496-63f6-4207-b4c5-2c1c73ca897a",
"AssemblyLoadProperties": [
"NET4",
"SDK_NET4"
],
"AssemblyTime": "2016-05-25T14:01:07Z",
"CompatibilityVersion": 2,
"IsBrowsable": true,
"IsNonEditableConfig": false,
"LoadedAssemblyTime": "1970-01-01T00:00:00Z",
"LoadedVersion": "",
"Version": "2.10.0.8516",
"Links": {
"Self": "https://localhost.osisoft.int/piwebapi/notificationplugins/F1DCDqD5loBNH0erqeqJodtALA1jVcFNf02UGGrgjlCY06lgUkVTVFVOSVRcUExVR0lOU0RFTElWRVJZQ0hBTk5FTFtXRUJTRVJWSUNFXQ"
}
}