Skip to content

/AWS1/IF_LM2=>LISTBOTANALYZERHISTORY()

About ListBotAnalyzerHistory

Retrieves a list of historical bot analysis executions for a specific bot. You can filter the results by locale and bot version.

The history includes all analysis executions regardless of their status, allowing you to track past analyses and their outcomes.

Method Signature

METHODS /AWS1/IF_LM2~LISTBOTANALYZERHISTORY
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IV_LOCALEID TYPE /AWS1/LM2LOCALEID OPTIONAL
    !IV_BOTVERSION TYPE /AWS1/LM2DRAFTBOTVERSION OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2listbotanlzhistrsp
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2RESOURCENOTFOUNDEX
    /AWS1/CX_LM2THROTTLINGEX
    /AWS1/CX_LM2VALIDATIONEX
    /AWS1/CX_LM2CLIENTEXC
    /AWS1/CX_LM2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_botid TYPE /AWS1/LM2ID /AWS1/LM2ID

The unique identifier of the bot.

Optional arguments:

iv_localeid TYPE /AWS1/LM2LOCALEID /AWS1/LM2LOCALEID

The locale identifier to filter the history. If not specified, returns history for all locales.

iv_botversion TYPE /AWS1/LM2DRAFTBOTVERSION /AWS1/LM2DRAFTBOTVERSION

The bot version to filter the history. If not specified, defaults to DRAFT.

iv_nexttoken TYPE /AWS1/LM2NEXTTOKEN /AWS1/LM2NEXTTOKEN

If the response from a previous request was truncated, the nextToken value is used to retrieve the next page of history entries.

iv_maxresults TYPE /AWS1/LM2MAXRESULTS /AWS1/LM2MAXRESULTS

The maximum number of history entries to return in the response. The default is 10.

RETURNING

oo_output TYPE REF TO /aws1/cl_lm2listbotanlzhistrsp /AWS1/CL_LM2LISTBOTANLZHISTRSP

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->listbotanalyzerhistory(
  iv_botid = |string|
  iv_botversion = |string|
  iv_localeid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_botid( ).
  lv_localeid = lo_result->get_localeid( ).
  lv_draftbotversion = lo_result->get_botversion( ).
  LOOP AT lo_result->get_botanalyzerhistorylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_botanalyzerstatus = lo_row_1->get_botanalyzerstatus( ).
      lv_timestamp = lo_row_1->get_creationdatetime( ).
      lv_uuid = lo_row_1->get_botanalyzerrequestid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.