Show TOC

Searching for Alert Rules (Query)Locate this document in the navigation structure

Prerequisites

  • The user calling the Web service operations has to have the authorization roles SAP_XI_ALERTCONF_DISPLAY_J2EE or SAP_XI_ALERT_CONFIGURATOR_J2EE.

    If the security settings on your system allow this, you might also use a user account that has the SAP_XI_DISPLAY_API_J2EE authorization role. For more information, see Assigning Permissions .

  • You can use the standard error handling process in the Integration Directory API. For more information, see Error Handling .

Features

Using the Query operation you can search for a set of active alert rules in Integration Directory. You can restrict the search to specific search criteria.

Note

The Query operation provides results about active alert rules. In case the Integration Directory contains alert rules that have not been activated, they would be excluded from the search results even if they matched the search criteria.

The following input parameters are included in the AlertRuleQueryRequest data structure:

  • Use the AlertRuleID input parameter to specify the name of the alert rule you want to find.

    If you do not specify a value, the search returns all alert rules.

  • Use Description and AdministrativeData to specify additional search criteria.

    These data types are common for Integration Directory. If you do not specify a value, the search returns all alert rules. For more information, see Cross-Object-Type Elements .

The operation response contains the active alert rules that meet the search criteria you specified. The results are provided in the AlertRuleQueryResponse data structure, which contains the following information for each alert rule:

  • The AlertRule data structure contains the name and the technical ID of the alert rule: AlertRuleID and AlertRuleTechnicalID

  • The Description and AdministrativeData data structures provide details about the alert rule.

  • Severity describes the severity of the alert rule. The parameter can have one of the following values: VERYHIGH, HIGH, MEDIUM, or LOW

  • The State parameter shows if the current alert rule is enabled or disabled for the runtime components. The parameter can have one of the ENABLED or DISABLED values.

  • AlertConsumers contains a list of IDs of alert consumers that are subscribed for this alert rule.

  • LogMessageCollection contains list of possible error or other messages.