Configure a REST web service delivery endpoint

To configure a web service delivery endpoint and add a REST web service subscriber to your notification rule, follow this procedure. For SOAP web service, see Configure a SOAP web service delivery endpoint.

1. Add a web service delivery endpoint using the PI System Explorer Contacts plug-in.

   1. Go to the Contacts plug-in of the PI System Explorer.

   2. Right-click the Delivery Endpoints folder.

   3. Select New Delivery Endpoint.

   4. Optional. Retry interval. Select the time interval at which PI Notifications Service will contact the web service. The web service will be contacted as frequently as the system allows if zero is entered.

   5. Optional. Maximum Retries. Select the number of times PI Notifications Service will try to connect to the web service. Entering zero means there will be no retries.

   6. Select WebService from the drop-down list next to Delivery channel.

   7. Select REST.

   8. Enter the URL of your web service.

   9. Select Http Method, a default web method to be used for the notification. Supported methods are POST, PUT and PATCH.

   10. Select Authentication Option.

       • Windows: the default option. PI Notifications Service will pass the network credentials of its service account to the web service

       • Anonymous: no credentials will be provided to the web service

       • Basic: enter a username and password the service will provide to the web service

   11. Check in the changes.

   See Create a delivery endpoint such as a stand-alone email or a web service row in Manage contacts and List of options for the notifications web service delivery channel for more information. See also Configure authentication for a web service connection for authentication of web service.

2. Add the configured web service delivery endpoint to your notification rule as a subscriber.

   1. Go to the Notification Rules tab of the element you want to add the web service as the delivery endpoint.

   2. Click View/Edit subscriptions in the Subscriptions pane of the notification rule.

   3. From the Contacts pane on the right side, expand Delivery Endpoints and drag the configured REST web service to the Subscriptions pane on the left.

   4. Click the wrench icon to open the Web Service Configuration window to configure the JSON object for the REST API method.

      REST can send a JSON object to the REST server in HTTP methods PUT, POST or PATCH.

   5. Click the Body tab to enter the path and value on each row.

      Currently, only JSON payloads are supported; query string parameters are not supported.

      If you hover over the help icon, you see sample JSON parameters (path and value) that are necessary for configuring this method:

      

      You can validate the method using the Test Send button.

   6. Click the Headers tab to enter HTTP headers for your request.

      You use headers to pass additional information along with your request. You can enter the key and value pair on each row. Common HTTP headers will be available in a drop-down list to enter as a key (for example, Content-Type).

      Note: The default value of the HTTP header Content-Type is application/json; charset=utf-8.

      You can also enter a custom header if your web service requires a specific type of header (for example, a custom API key header.)

      You can validate the request using the Test Send button.