Alerting API on Integration Directory
The Web service for the Alert Rule directory object is part of the Integration Directory API. When you want to develop an alert consumer, you should implement in it a Web service client that connects to the alerting API in the Integration Directory. This way your alert consumer would be able to do the following:
-
Access and retrieve information about alert rules from the Integration Directory.
-
Register your alert consumer for alert rules.
In addition to the ability of your alert consumer to work with alert rules in the Integration Directory, you should also enable it to retrieve alerts from the Alert Engines on the runtime components. You can do this by utilizing the Web service API on the Alert Engines. For more information, see Alerting API on Alert Engine .
The service interface that corresponds to Alert Rule in the Integration Directory is AlertRuleIn|http://sap.com/xi/BASIS|SAP BASIS 7.31. This service interface has the following operations:
-
Query for querying the Integration Directory about existing active alert rules.
For more information, see Searching for Alert Rules (Query) .
-
RegisterConsumer for registering an alert consumer for a selected set of alert rules.
For more information, see Subscribing Consumers to Alert Rules (RegisterConsumer) .
-
DeregisterConsumer for deregistering an alert consumer for a selected set of alert rules.
For more information, see Unsubscribing Consumers (DeregisterConsumer) .
-
RetrieveRuntimeComponents for obtaining the SLD names of the assigned runtime components for a set of alert rules.
For more information, see Retrieving Component Information (RetrieveRuntimeComponents) .
The alerting Web service in the Integration Directory has the following endpoints:
-
AlertRuleInPort for HTTP communication.
-
AlertRuleInPortHTTPS for secure HTTPS communication.