LISTSEARCHES()`¶

About ListSearches¶

Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

Method Signature¶

METHODS /AWS1/IF_IOS~LISTSEARCHES
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSLISTSRCHESREQMAXRSINT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOSNEXTTOKEN OPTIONAL
    !IO_LISTSEARCHESFILTERS TYPE REF TO /AWS1/CL_IOSLISTSEARCHESFILTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioslistsearchesrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspacename` `TYPE /AWS1/IOSWORKSPACENAME` `/AWS1/IOSWORKSPACENAME`¶

The name of the workspace whose searches are listed.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/IOSLISTSRCHESREQMAXRSINT` `/AWS1/IOSLISTSRCHESREQMAXRSINT`¶

The maximum number of searches to return in a single page. Valid range is 1 to 1,000; if omitted, a service-defined default is used.

`iv_nexttoken` `TYPE /AWS1/IOSNEXTTOKEN` `/AWS1/IOSNEXTTOKEN`¶

The pagination token returned by a previous ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.

`io_listsearchesfilters` `TYPE REF TO /AWS1/CL_IOSLISTSEARCHESFILTS` `/AWS1/CL_IOSLISTSEARCHESFILTS`¶

Optional filters that restrict which searches are returned.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioslistsearchesrsp` `/AWS1/CL_IOSLISTSEARCHESRSP`¶

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->listsearches(
  io_listsearchesfilters = new /aws1/cl_ioslistsearchesfilts(
    it_groupidfilter = VALUE /aws1/cl_iosgroupidfiltlist_w=>tt_groupidfilterlist(
      ( new /aws1/cl_iosgroupidfiltlist_w( |string| ) )
    )
    it_searchtypefilter = VALUE /aws1/cl_iossrchtypefiltlist_w=>tt_searchtypefilterlist(
      ( new /aws1/cl_iossrchtypefiltlist_w( |string| ) )
    )
    it_statusfilter = VALUE /aws1/cl_iossrchstatfiltlist_w=>tt_searchstatusfilterlist(
      ( new /aws1/cl_iossrchstatfiltlist_w( |string| ) )
    )
    iv_startedafter = '20150101000000.0000000'
    iv_startedbefore = '20150101000000.0000000'
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_workspacename = |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_searchsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_searchid = lo_row_1->get_searchid( ).
      lv_workspacename = lo_row_1->get_workspacename( ).
      lv_searchstatus = lo_row_1->get_status( ).
      lv_searchquerystatement = lo_row_1->get_querystatement( ).
      lv_searchtype = lo_row_1->get_searchtype( ).
      lv_string = lo_row_1->get_statusreason( ).
      lv_timestamp = lo_row_1->get_startedat( ).
      lv_groupid = lo_row_1->get_groupid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOS=>LISTSEARCHES()¶