Skip to content

/AWS1/IF_AGW=>TESTINVOKEMETHOD()

About TestInvokeMethod

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

Method Signature

METHODS /AWS1/IF_AGW~TESTINVOKEMETHOD
  IMPORTING
    !IV_RESTAPIID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_RESOURCEID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_HTTPMETHOD TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_PATHWITHQUERYSTRING TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_BODY TYPE /AWS1/AGWSTRING OPTIONAL
    !IT_HEADERS TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING OPTIONAL
    !IT_MULTIVALUEHEADERS TYPE /AWS1/CL_AGWLISTOFSTRING_W=>TT_MAPOFSTRINGTOLIST OPTIONAL
    !IV_CLIENTCERTIFICATEID TYPE /AWS1/AGWSTRING OPTIONAL
    !IT_STAGEVARIABLES TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwtestinvkmethodrsp
  RAISING
    /AWS1/CX_AGWBADREQUESTEX
    /AWS1/CX_AGWNOTFOUNDEXCEPTION
    /AWS1/CX_AGWTOOMANYREQUESTSEX
    /AWS1/CX_AGWUNAUTHORIZEDEX
    /AWS1/CX_AGWCLIENTEXC
    /AWS1/CX_AGWSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_restapiid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The string identifier of the associated RestApi.

iv_resourceid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

Specifies a test invoke method request's resource ID.

iv_httpmethod TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

Specifies a test invoke method request's HTTP method.

Optional arguments:

iv_pathwithquerystring TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

iv_body TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The simulated request body of an incoming invocation request.

it_headers TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING TT_MAPOFSTRINGTOSTRING

A key-value map of headers to simulate an incoming invocation request.

it_multivalueheaders TYPE /AWS1/CL_AGWLISTOFSTRING_W=>TT_MAPOFSTRINGTOLIST TT_MAPOFSTRINGTOLIST

The headers as a map from string to list of values to simulate an incoming invocation request.

iv_clientcertificateid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

it_stagevariables TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING TT_MAPOFSTRINGTOSTRING

A key-value map of stage variables to simulate an invocation on a deployed Stage.

RETURNING

oo_output TYPE REF TO /aws1/cl_agwtestinvkmethodrsp /AWS1/CL_AGWTESTINVKMETHODRSP

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->testinvokemethod(
  it_headers = VALUE /aws1/cl_agwmapofstrtostr_w=>tt_mapofstringtostring(
    (
      VALUE /aws1/cl_agwmapofstrtostr_w=>ts_mapofstringtostring_maprow(
        key = |string|
        value = new /aws1/cl_agwmapofstrtostr_w( |string| )
      )
    )
  )
  it_multivalueheaders = VALUE /aws1/cl_agwlistofstring_w=>tt_mapofstringtolist(
    (
      VALUE /aws1/cl_agwlistofstring_w=>ts_mapofstringtolist_maprow(
        key = |string|
        value = VALUE /aws1/cl_agwlistofstring_w=>tt_listofstring(
          ( new /aws1/cl_agwlistofstring_w( |string| ) )
        )
      )
    )
  )
  it_stagevariables = VALUE /aws1/cl_agwmapofstrtostr_w=>tt_mapofstringtostring(
    (
      VALUE /aws1/cl_agwmapofstrtostr_w=>ts_mapofstringtostring_maprow(
        key = |string|
        value = new /aws1/cl_agwmapofstrtostr_w( |string| )
      )
    )
  )
  iv_body = |string|
  iv_clientcertificateid = |string|
  iv_httpmethod = |string|
  iv_pathwithquerystring = |string|
  iv_resourceid = |string|
  iv_restapiid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_integer = lo_result->get_status( ).
  lv_string = lo_result->get_body( ).
  LOOP AT lo_result->get_headers( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_string = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_multivalueheaders( ) into ls_row_1.
    lv_key = ls_row_1-key.
    LOOP AT ls_row_1-value into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDLOOP.
  lv_string = lo_result->get_log( ).
  lv_long = lo_result->get_latency( ).
ENDIF.