Show TOC

Retrieving Component Information (RetrieveRuntimeComponents)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 RetrieveRuntimeComponents operation, for each alert rule you specify whether you can obtain information about the SLD names of all runtime components to which it applies.

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

  • Use the AlertRuleID input parameter to specify the name of the alert rules for which you need to know the corresponding runtime components.

    It is mandatory to specify a value for this parameter.

The operation response contains the results of the search. The results are provided in the AlertRuleRetrieveRuntimeComponentsResponse data structure, which contains the following information:

  • The AlertRuleRuntimeComponents data structure contains the name of the alert rule (parameter AlertRuleID), as well as the SLD names (parameter ComponentName) of the runtime components to which this alert rule applies.

  • LogMessageCollection contains list of possible error or other messages.