LISTBOTS()`¶

About ListBots¶

Gets a list of available bots.

Method Signature¶

METHODS /AWS1/IF_LM2~LISTBOTS
  IMPORTING
    !IO_SORTBY TYPE REF TO /AWS1/CL_LM2BOTSORTBY OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_LM2BOTFILTER=>TT_BOTFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2listbotsresponse
  RAISING
    /AWS1/CX_LM2INTERNALSERVEREX
    /AWS1/CX_LM2SERVICEQUOTAEXCDEX
    /AWS1/CX_LM2THROTTLINGEX
    /AWS1/CX_LM2VALIDATIONEX
    /AWS1/CX_LM2CLIENTEXC
    /AWS1/CX_LM2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`io_sortby` `TYPE REF TO /AWS1/CL_LM2BOTSORTBY` `/AWS1/CL_LM2BOTSORTBY`¶

Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

`it_filters` `TYPE /AWS1/CL_LM2BOTFILTER=>TT_BOTFILTERS` `TT_BOTFILTERS`¶

Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

`iv_maxresults` `TYPE /AWS1/LM2MAXRESULTS` `/AWS1/LM2MAXRESULTS`¶

The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

`iv_nexttoken` `TYPE /AWS1/LM2NEXTTOKEN` `/AWS1/LM2NEXTTOKEN`¶

If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lm2listbotsresponse` `/AWS1/CL_LM2LISTBOTSRESPONSE`¶

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->listbots(
  io_sortby = new /aws1/cl_lm2botsortby(
    iv_attribute = |string|
    iv_order = |string|
  )
  it_filters = VALUE /aws1/cl_lm2botfilter=>tt_botfilters(
    (
      new /aws1/cl_lm2botfilter(
        it_values = VALUE /aws1/cl_lm2filtervalues_w=>tt_filtervalues(
          ( new /aws1/cl_lm2filtervalues_w( |string| ) )
        )
        iv_name = |string|
        iv_operator = |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.
  LOOP AT lo_result->get_botsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_botid( ).
      lv_name = lo_row_1->get_botname( ).
      lv_description = lo_row_1->get_description( ).
      lv_botstatus = lo_row_1->get_botstatus( ).
      lv_numericalbotversion = lo_row_1->get_latestbotversion( ).
      lv_timestamp = lo_row_1->get_lastupdateddatetime( ).
      lv_bottype = lo_row_1->get_bottype( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_LM2=>LISTBOTS()¶