Skip to content

/AWS1/IF_MDL=>LISTALERTS()

About ListAlerts

List the alerts for a channel with optional filtering based on alert state.

Method Signature

METHODS /AWS1/IF_MDL~LISTALERTS
  IMPORTING
    !IV_CHANNELID TYPE /AWS1/MDL__STRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MDLMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MDL__STRING OPTIONAL
    !IV_STATEFILTER TYPE /AWS1/MDL__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mdllistalertsresponse
  RAISING
    /AWS1/CX_MDLBADGATEWAYEX
    /AWS1/CX_MDLBADREQUESTEX
    /AWS1/CX_MDLFORBIDDENEXCEPTION
    /AWS1/CX_MDLGATEWAYTIMEOUTEX
    /AWS1/CX_MDLINTERNALSERVERER00
    /AWS1/CX_MDLNOTFOUNDEXCEPTION
    /AWS1/CX_MDLTOOMANYREQUESTSEX
    /AWS1/CX_MDLCLIENTEXC
    /AWS1/CX_MDLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_channelid TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING

The unique ID of the channel

Optional arguments:

iv_maxresults TYPE /AWS1/MDLMAXRESULTS /AWS1/MDLMAXRESULTS

The maximum number of items to return

iv_nexttoken TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING

The next pagination token

iv_statefilter TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING

Specifies the set of alerts to return based on their state. SET - Return only alerts with SET state. CLEARED - Return only alerts with CLEARED state. ALL - Return all alerts.

RETURNING

oo_output TYPE REF TO /aws1/cl_mdllistalertsresponse /AWS1/CL_MDLLISTALERTSRESPONSE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listalerts(
  iv_channelid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_statefilter = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_alerts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv___string = lo_row_1->get_alerttype( ).
      lv___timestampiso8601 = lo_row_1->get_clearedtimestamp( ).
      lv___string = lo_row_1->get_id( ).
      lv___string = lo_row_1->get_message( ).
      lv___string = lo_row_1->get_pipelineid( ).
      lv___timestampiso8601 = lo_row_1->get_settimestamp( ).
      lv_channelalertstate = lo_row_1->get_state( ).
    ENDIF.
  ENDLOOP.
  lv___string = lo_result->get_nexttoken( ).
ENDIF.