LISTWATCHLISTS()`¶

About ListWatchlists¶

Lists all watchlists in a specified domain.

Method Signature¶

METHODS /AWS1/IF_VID~LISTWATCHLISTS
  IMPORTING
    !IV_DOMAINID TYPE /AWS1/VIDDOMAINID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/VIDMAXRESULTSFORLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/VIDNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_vidlistwatchlistsrsp
  RAISING
    /AWS1/CX_VIDACCESSDENIEDEX
    /AWS1/CX_VIDINTERNALSERVEREX
    /AWS1/CX_VIDRESOURCENOTFOUNDEX
    /AWS1/CX_VIDTHROTTLINGEX
    /AWS1/CX_VIDVALIDATIONEX
    /AWS1/CX_VIDCLIENTEXC
    /AWS1/CX_VIDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainid` `TYPE /AWS1/VIDDOMAINID` `/AWS1/VIDDOMAINID`¶

The identifier of the domain.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/VIDMAXRESULTSFORLIST` `/AWS1/VIDMAXRESULTSFORLIST`¶

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

`iv_nexttoken` `TYPE /AWS1/VIDNEXTTOKEN` `/AWS1/VIDNEXTTOKEN`¶

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_vidlistwatchlistsrsp` `/AWS1/CL_VIDLISTWATCHLISTSRSP`¶

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->listwatchlists(
  iv_domainid = |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_watchlistsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_domainid = lo_row_1->get_domainid( ).
      lv_watchlistid = lo_row_1->get_watchlistid( ).
      lv_watchlistname = lo_row_1->get_name( ).
      lv_watchlistdescription = lo_row_1->get_description( ).
      lv_boolean = lo_row_1->get_defaultwatchlist( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_VID=>LISTWATCHLISTS()¶