LISTOPERATIONS()`¶

About ListOperations¶

Lists operations that match the criteria that you specify.

Method Signature¶

METHODS /AWS1/IF_SDY~LISTOPERATIONS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SDYNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SDYMAXRESULTS OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_SDYOPERATIONFILTER=>TT_OPERATIONFILTERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sdylistopsresponse
  RAISING
    /AWS1/CX_SDYINVALIDINPUT
    /AWS1/CX_SDYCLIENTEXC
    /AWS1/CX_SDYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SDYNEXTTOKEN` `/AWS1/SDYNEXTTOKEN`¶

For the first ListOperations request, omit this value.

If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

`iv_maxresults` `TYPE /AWS1/SDYMAXRESULTS` `/AWS1/SDYMAXRESULTS`¶

The maximum number of items that you want Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 operations.

`it_filters` `TYPE /AWS1/CL_SDYOPERATIONFILTER=>TT_OPERATIONFILTERS` `TT_OPERATIONFILTERS`¶

A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.

If you specify more than one filter, an operation must match all filters to be returned by ListOperations.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sdylistopsresponse` `/AWS1/CL_SDYLISTOPSRESPONSE`¶

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->listoperations(
  it_filters = VALUE /aws1/cl_sdyoperationfilter=>tt_operationfilters(
    (
      new /aws1/cl_sdyoperationfilter(
        it_values = VALUE /aws1/cl_sdyfiltervalues_w=>tt_filtervalues(
          ( new /aws1/cl_sdyfiltervalues_w( |string| ) )
        )
        iv_condition = |string|
        iv_name = |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_operations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_operationid = lo_row_1->get_id( ).
      lv_operationstatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

ListOperations Example¶

This example gets the operations that have a STATUS of either PENDING or SUCCESS.

DATA(lo_result) = lo_client->listoperations(
  it_filters = VALUE /aws1/cl_sdyoperationfilter=>tt_operationfilters(
    (
      new /aws1/cl_sdyoperationfilter(
        it_values = VALUE /aws1/cl_sdyfiltervalues_w=>tt_filtervalues(
          ( new /aws1/cl_sdyfiltervalues_w( |PENDING| ) )
          ( new /aws1/cl_sdyfiltervalues_w( |SUCCESS| ) )
        )
        iv_condition = |IN|
        iv_name = |STATUS|
      )
    )
  )
).

/AWS1/IF_SDY=>LISTOPERATIONS()¶