Skip to content

/AWS1/IF_NWM=>GETLINKS()

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

Method Signature

METHODS /AWS1/IF_NWM~GETLINKS
  IMPORTING
    !IV_GLOBALNETWORKID TYPE /AWS1/NWMGLOBALNETWORKID OPTIONAL
    !IT_LINKIDS TYPE /AWS1/CL_NWMLINKIDLIST_W=>TT_LINKIDLIST OPTIONAL
    !IV_SITEID TYPE /AWS1/NWMSITEID OPTIONAL
    !IV_TYPE TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IV_PROVIDER TYPE /AWS1/NWMCONSTRAINEDSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/NWMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/NWMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nwmgetlinksresponse
  RAISING
    /AWS1/CX_NWMACCESSDENIEDEX
    /AWS1/CX_NWMINTERNALSERVEREX
    /AWS1/CX_NWMRESOURCENOTFOUNDEX
    /AWS1/CX_NWMTHROTTLINGEX
    /AWS1/CX_NWMVALIDATIONEX
    /AWS1/CX_NWMCLIENTEXC
    /AWS1/CX_NWMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_globalnetworkid TYPE /AWS1/NWMGLOBALNETWORKID /AWS1/NWMGLOBALNETWORKID

The ID of the global network.

Optional arguments:

it_linkids TYPE /AWS1/CL_NWMLINKIDLIST_W=>TT_LINKIDLIST TT_LINKIDLIST

One or more link IDs. The maximum is 10.

iv_siteid TYPE /AWS1/NWMSITEID /AWS1/NWMSITEID

The ID of the site.

iv_type TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

The link type.

iv_provider TYPE /AWS1/NWMCONSTRAINEDSTRING /AWS1/NWMCONSTRAINEDSTRING

The link provider.

iv_maxresults TYPE /AWS1/NWMMAXRESULTS /AWS1/NWMMAXRESULTS

The maximum number of results to return.

iv_nexttoken TYPE /AWS1/NWMNEXTTOKEN /AWS1/NWMNEXTTOKEN

The token for the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_nwmgetlinksresponse /AWS1/CL_NWMGETLINKSRESPONSE

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->getlinks(
  it_linkids = VALUE /aws1/cl_nwmlinkidlist_w=>tt_linkidlist(
    ( new /aws1/cl_nwmlinkidlist_w( |string| ) )
  )
  iv_globalnetworkid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_provider = |string|
  iv_siteid = |string|
  iv_type = |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_linkid = lo_row_1->get_linkid( ).
      lv_linkarn = lo_row_1->get_linkarn( ).
      lv_globalnetworkid = lo_row_1->get_globalnetworkid( ).
      lv_siteid = lo_row_1->get_siteid( ).
      lv_constrainedstring = lo_row_1->get_description( ).
      lv_constrainedstring = lo_row_1->get_type( ).
      lo_bandwidth = lo_row_1->get_bandwidth( ).
      IF lo_bandwidth IS NOT INITIAL.
        lv_integer = lo_bandwidth->get_uploadspeed( ).
        lv_integer = lo_bandwidth->get_downloadspeed( ).
      ENDIF.
      lv_constrainedstring = lo_row_1->get_provider( ).
      lv_datetime = lo_row_1->get_createdat( ).
      lv_linkstate = lo_row_1->get_state( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_tagkey = lo_row_3->get_key( ).
          lv_tagvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.