Skip to content

/AWS1/IF_MPB=>LISTLINKS()

Lists links associated with an RTB application.

Returns a list of all links for the specified RTB application, including their status and configuration details.

Method Signature

METHODS /AWS1/IF_MPB~LISTLINKS
  IMPORTING
    !IV_GATEWAYID TYPE /AWS1/MPBGATEWAYID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MPBSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MPBINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_mpblistlinksresponse
  RAISING
    /AWS1/CX_MPBACCESSDENIEDEX
    /AWS1/CX_MPBINTERNALSERVEREX
    /AWS1/CX_MPBRESOURCENOTFOUNDEX
    /AWS1/CX_MPBTHROTTLINGEX
    /AWS1/CX_MPBVALIDATIONEX
    /AWS1/CX_MPBCLIENTEXC
    /AWS1/CX_MPBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_gatewayid TYPE /AWS1/MPBGATEWAYID /AWS1/MPBGATEWAYID

The unique identifier of the gateway.

Optional arguments:

iv_nexttoken TYPE /AWS1/MPBSTRING /AWS1/MPBSTRING

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. Using an expired pagination token will return an HTTP 400 InvalidToken error.

iv_maxresults TYPE /AWS1/MPBINTEGER /AWS1/MPBINTEGER

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

RETURNING

oo_output TYPE REF TO /aws1/cl_mpblistlinksresponse /AWS1/CL_MPBLISTLINKSRESPONSE

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->listlinks(
  iv_gatewayid = |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_links( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_gatewayid = lo_row_1->get_gatewayid( ).
      lv_gatewayid = lo_row_1->get_peergatewayid( ).
      lv_linkstatus = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
      lv_linkdirection = lo_row_1->get_direction( ).
      LOOP AT lo_row_1->get_flowmodules( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_version = lo_row_3->get_version( ).
          lv_flowmodulename = lo_row_3->get_name( ).
          LOOP AT lo_row_3->get_dependson( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_flowmodulename = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lo_moduleparameters = lo_row_3->get_moduleparameters( ).
          IF lo_moduleparameters IS NOT INITIAL.
            lo_nobidmoduleparameters = lo_moduleparameters->get_nobid( ).
            IF lo_nobidmoduleparameters IS NOT INITIAL.
              lv_string = lo_nobidmoduleparameters->get_reason( ).
              lv_integer = lo_nobidmoduleparameters->get_reasoncode( ).
              lv_float = lo_nobidmoduleparameters->get_passthroughpercentage( ).
            ENDIF.
            lo_openrtbattributemodulep = lo_moduleparameters->get_openrtbattribute( ).
            IF lo_openrtbattributemodulep IS NOT INITIAL.
              lv_filtertype = lo_openrtbattributemodulep->get_filtertype( ).
              LOOP AT lo_openrtbattributemodulep->get_filterconfiguration( ) into lo_row_6.
                lo_row_7 = lo_row_6.
                IF lo_row_7 IS NOT INITIAL.
                  LOOP AT lo_row_7->get_criteria( ) into lo_row_8.
                    lo_row_9 = lo_row_8.
                    IF lo_row_9 IS NOT INITIAL.
                      lv_string = lo_row_9->get_path( ).
                      LOOP AT lo_row_9->get_values( ) into lo_row_10.
                        lo_row_11 = lo_row_10.
                        IF lo_row_11 IS NOT INITIAL.
                          lv_string = lo_row_11->get_value( ).
                        ENDIF.
                      ENDLOOP.
                    ENDIF.
                  ENDLOOP.
                ENDIF.
              ENDLOOP.
              lo_action = lo_openrtbattributemodulep->get_action( ).
              IF lo_action IS NOT INITIAL.
                lo_nobidaction = lo_action->get_nobid( ).
                IF lo_nobidaction IS NOT INITIAL.
                  lv_integer = lo_nobidaction->get_nobidreasoncode( ).
                ENDIF.
                lo_headertagaction = lo_action->get_headertag( ).
                IF lo_headertagaction IS NOT INITIAL.
                  lv_string = lo_headertagaction->get_name( ).
                  lv_string = lo_headertagaction->get_value( ).
                ENDIF.
              ENDIF.
              lv_float = lo_openrtbattributemodulep->get_holdbackpercentage( ).
            ENDIF.
            lo_ratelimitermoduleparame = lo_moduleparameters->get_ratelimiter( ).
            IF lo_ratelimitermoduleparame IS NOT INITIAL.
              lv_float = lo_ratelimitermoduleparame->get_tps( ).
            ENDIF.
          ENDIF.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_pendingflowmodules( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_version = lo_row_3->get_version( ).
          lv_flowmodulename = lo_row_3->get_name( ).
          LOOP AT lo_row_3->get_dependson( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_flowmodulename = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lo_moduleparameters = lo_row_3->get_moduleparameters( ).
          IF lo_moduleparameters IS NOT INITIAL.
            lo_nobidmoduleparameters = lo_moduleparameters->get_nobid( ).
            IF lo_nobidmoduleparameters IS NOT INITIAL.
              lv_string = lo_nobidmoduleparameters->get_reason( ).
              lv_integer = lo_nobidmoduleparameters->get_reasoncode( ).
              lv_float = lo_nobidmoduleparameters->get_passthroughpercentage( ).
            ENDIF.
            lo_openrtbattributemodulep = lo_moduleparameters->get_openrtbattribute( ).
            IF lo_openrtbattributemodulep IS NOT INITIAL.
              lv_filtertype = lo_openrtbattributemodulep->get_filtertype( ).
              LOOP AT lo_openrtbattributemodulep->get_filterconfiguration( ) into lo_row_6.
                lo_row_7 = lo_row_6.
                IF lo_row_7 IS NOT INITIAL.
                  LOOP AT lo_row_7->get_criteria( ) into lo_row_8.
                    lo_row_9 = lo_row_8.
                    IF lo_row_9 IS NOT INITIAL.
                      lv_string = lo_row_9->get_path( ).
                      LOOP AT lo_row_9->get_values( ) into lo_row_10.
                        lo_row_11 = lo_row_10.
                        IF lo_row_11 IS NOT INITIAL.
                          lv_string = lo_row_11->get_value( ).
                        ENDIF.
                      ENDLOOP.
                    ENDIF.
                  ENDLOOP.
                ENDIF.
              ENDLOOP.
              lo_action = lo_openrtbattributemodulep->get_action( ).
              IF lo_action IS NOT INITIAL.
                lo_nobidaction = lo_action->get_nobid( ).
                IF lo_nobidaction IS NOT INITIAL.
                  lv_integer = lo_nobidaction->get_nobidreasoncode( ).
                ENDIF.
                lo_headertagaction = lo_action->get_headertag( ).
                IF lo_headertagaction IS NOT INITIAL.
                  lv_string = lo_headertagaction->get_name( ).
                  lv_string = lo_headertagaction->get_value( ).
                ENDIF.
              ENDIF.
              lv_float = lo_openrtbattributemodulep->get_holdbackpercentage( ).
            ENDIF.
            lo_ratelimitermoduleparame = lo_moduleparameters->get_ratelimiter( ).
            IF lo_ratelimitermoduleparame IS NOT INITIAL.
              lv_float = lo_ratelimitermoduleparame->get_tps( ).
            ENDIF.
          ENDIF.
        ENDIF.
      ENDLOOP.
      lo_linkattributes = lo_row_1->get_attributes( ).
      IF lo_linkattributes IS NOT INITIAL.
        LOOP AT lo_linkattributes->get_respondererrormasking( ) into lo_row_12.
          lo_row_13 = lo_row_12.
          IF lo_row_13 IS NOT INITIAL.
            lv_string = lo_row_13->get_httpcode( ).
            lv_respondererrormaskingac = lo_row_13->get_action( ).
            LOOP AT lo_row_13->get_loggingtypes( ) into lo_row_14.
              lo_row_15 = lo_row_14.
              IF lo_row_15 IS NOT INITIAL.
                lv_respondererrormaskinglo = lo_row_15->get_value( ).
              ENDIF.
            ENDLOOP.
            lv_float = lo_row_13->get_rsploggingpercentage( ).
          ENDIF.
        ENDLOOP.
        lv_customerprovidedid = lo_linkattributes->get_customerprovidedid( ).
      ENDIF.
      lv_linkid = lo_row_1->get_linkid( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_16.
        lv_key = ls_row_16-key.
        lo_value = ls_row_16-value.
        IF lo_value IS NOT INITIAL.
          lv_tagvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

Lists all links for the specified gateway

DATA(lo_result) = lo_client->listlinks(
  iv_gatewayid = |rtb-gw-12345678|
  iv_maxresults = 10
).