/AWS1/IF_AGW=>PUTINTEGRATIONRESPONSE()

About PutIntegrationResponse

Represents a put integration.

Method Signature

METHODS /AWS1/IF_AGW~PUTINTEGRATIONRESPONSE
  IMPORTING
    !IV_RESTAPIID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_RESOURCEID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_HTTPMETHOD TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_STATUSCODE TYPE /AWS1/AGWSTATUSCODE OPTIONAL
    !IV_SELECTIONPATTERN TYPE /AWS1/AGWSTRING OPTIONAL
    !IT_RESPONSEPARAMETERS TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING OPTIONAL
    !IT_RESPONSETEMPLATES TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING OPTIONAL
    !IV_CONTENTHANDLING TYPE /AWS1/AGWCONTENTHANDLINGSTRAG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwintegrationrsp
  RAISING
    /AWS1/CX_AGWBADREQUESTEX
    /AWS1/CX_AGWCONFLICTEXCEPTION
    /AWS1/CX_AGWLIMITEXCEEDEDEX
    /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 put integration response request's resource identifier.

iv_httpmethod TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

Specifies a put integration response request's HTTP method.

iv_statuscode TYPE /AWS1/AGWSTATUSCODE /AWS1/AGWSTATUSCODE

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Optional arguments:

iv_selectionpattern TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

Specifies the selection pattern of a put integration response.

it_responseparameters TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING TT_MAPOFSTRINGTOSTRING

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

it_responsetemplates TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING TT_MAPOFSTRINGTOSTRING

Specifies a put integration response's templates.

iv_contenthandling TYPE /AWS1/AGWCONTENTHANDLINGSTRAG /AWS1/AGWCONTENTHANDLINGSTRAG

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

RETURNING

oo_output TYPE REF TO /aws1/cl_agwintegrationrsp /AWS1/CL_AGWINTEGRATIONRSP

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->putintegrationresponse(
  it_responseparameters = 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_responsetemplates = 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_contenthandling = |string|
  iv_httpmethod = |string|
  iv_resourceid = |string|
  iv_restapiid = |string|
  iv_selectionpattern = |string|
  iv_statuscode = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_statuscode = lo_result->get_statuscode( ).
  lv_string = lo_result->get_selectionpattern( ).
  LOOP AT lo_result->get_responseparameters( ) 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_responsetemplates( ) 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.
  lv_contenthandlingstrategy = lo_result->get_contenthandling( ).
ENDIF.