GETGATEWAYRESPONSES()`¶

About GetGatewayResponses¶

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Method Signature¶

METHODS /AWS1/IF_AGW~GETGATEWAYRESPONSES
  IMPORTING
    !IV_RESTAPIID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_POSITION TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_LIMIT TYPE /AWS1/AGWNULLABLEINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwgatewayresponses
  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.

Optional arguments:¶

`iv_position` `TYPE /AWS1/AGWSTRING` `/AWS1/AGWSTRING`¶

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

`iv_limit` `TYPE /AWS1/AGWNULLABLEINTEGER` `/AWS1/AGWNULLABLEINTEGER`¶

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_agwgatewayresponses` `/AWS1/CL_AGWGATEWAYRESPONSES`¶

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->getgatewayresponses(
  iv_limit = 123
  iv_position = |string|
  iv_restapiid = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_gatewayresponsetype = lo_row_1->get_responsetype( ).
      lv_statuscode = lo_row_1->get_statuscode( ).
      LOOP AT lo_row_1->get_responseparameters( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_responsetemplates( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_defaultresponse( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_position( ).
ENDIF.

/AWS1/IF_AGW=>GETGATEWAYRESPONSES()¶