Skip to content

/AWS1/CL_BDC=>LISTEVENTS()

About ListEvents

Lists events in a memory store based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the genesismemory:ListEvents permission.

Method Signature

IMPORTING

Required arguments:

iv_memoryid TYPE /AWS1/BDCMEMORYID /AWS1/BDCMEMORYID

The identifier of the memory store for which to list events.

iv_sessionid TYPE /AWS1/BDCSESSIONID /AWS1/BDCSESSIONID

The identifier of the session for which to list events. If specified, only events from this session are returned.

iv_actorid TYPE /AWS1/BDCACTORID /AWS1/BDCACTORID

The identifier of the actor for which to list events. If specified, only events from this actor are returned.

Optional arguments:

iv_includepayloads TYPE /AWS1/BDCBOOLEAN /AWS1/BDCBOOLEAN

Specifies whether to include event payloads in the response. Set to true to include payloads, or false to exclude them.

io_filter TYPE REF TO /AWS1/CL_BDCFILTERINPUT /AWS1/CL_BDCFILTERINPUT

Filter criteria to apply when listing events.

iv_maxresults TYPE /AWS1/BDCMAXRESULTS /AWS1/BDCMAXRESULTS

The maximum number of results to return in a single call. Minimum value of 1, maximum value of 100. Default is 20.

iv_nexttoken TYPE /AWS1/BDCPAGINATIONTOKEN /AWS1/BDCPAGINATIONTOKEN

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdclisteventsoutput /AWS1/CL_BDCLISTEVENTSOUTPUT

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->/aws1/if_bdc~listevents(
  io_filter = new /aws1/cl_bdcfilterinput(
    io_branch = new /aws1/cl_bdcbranchfilter(
      iv_includeparentbranches = ABAP_TRUE
      iv_name = |string|
    )
  )
  iv_actorid = |string|
  iv_includepayloads = ABAP_TRUE
  iv_maxresults = 123
  iv_memoryid = |string|
  iv_nexttoken = |string|
  iv_sessionid = |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_events( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_memoryid = lo_row_1->get_memoryid( ).
      lv_actorid = lo_row_1->get_actorid( ).
      lv_sessionid = lo_row_1->get_sessionid( ).
      lv_eventid = lo_row_1->get_eventid( ).
      lv_timestamp = lo_row_1->get_eventtimestamp( ).
      LOOP AT lo_row_1->get_payload( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lo_conversational = lo_row_3->get_conversational( ).
          IF lo_conversational IS NOT INITIAL.
            lo_content = lo_conversational->get_content( ).
            IF lo_content IS NOT INITIAL.
              lv_sensitivestring = lo_content->get_text( ).
            ENDIF.
            lv_role = lo_conversational->get_role( ).
          ENDIF.
          lo_value = lo_row_3->get_blob( ).
          IF lo_value IS NOT INITIAL.
          ENDIF.
        ENDIF.
      ENDLOOP.
      lo_branch = lo_row_1->get_branch( ).
      IF lo_branch IS NOT INITIAL.
        lv_eventid = lo_branch->get_rooteventid( ).
        lv_branchname = lo_branch->get_name( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.