LISTBOTVERSIONS()`¶

About ListBotVersions¶

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

Method Signature¶

METHODS /AWS1/IF_LM2~LISTBOTVERSIONS
  IMPORTING
    !IV_BOTID TYPE /AWS1/LM2ID OPTIONAL
    !IO_SORTBY TYPE REF TO /AWS1/CL_LM2BOTVERSIONSORTBY OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LM2MAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LM2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lm2listbotversionsrsp
  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¶

Required arguments:¶

`iv_botid` `TYPE /AWS1/LM2ID` `/AWS1/LM2ID`¶

The identifier of the bot to list versions for.

Optional arguments:¶

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

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

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

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

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

If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lm2listbotversionsrsp` `/AWS1/CL_LM2LISTBOTVERSIONSRSP`¶

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->listbotversions(
  io_sortby = new /aws1/cl_lm2botversionsortby(
    iv_attribute = |string|
    iv_order = |string|
  )
  iv_botid = |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( ).
  LOOP AT lo_result->get_botversionsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_name = lo_row_1->get_botname( ).
      lv_botversion = lo_row_1->get_botversion( ).
      lv_description = lo_row_1->get_description( ).
      lv_botstatus = lo_row_1->get_botstatus( ).
      lv_timestamp = lo_row_1->get_creationdatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_LM2=>LISTBOTVERSIONS()¶