IMPORTRESTAPI()`¶

About ImportRestApi¶

A feature of the API Gateway control service for creating a new API from an external API definition file.

Method Signature¶

METHODS /AWS1/IF_AGW~IMPORTRESTAPI
  IMPORTING
    !IV_FAILONWARNINGS TYPE /AWS1/AGWBOOLEAN OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING OPTIONAL
    !IV_BODY TYPE /AWS1/AGWBLOB OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwrestapi
  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_body` `TYPE /AWS1/AGWBLOB` `/AWS1/AGWBLOB`¶

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

Optional arguments:¶

`iv_failonwarnings` `TYPE /AWS1/AGWBOOLEAN` `/AWS1/AGWBOOLEAN`¶

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

`it_parameters` `TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING` `TT_MAPOFSTRINGTOSTRING`¶

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_agwrestapi` `/AWS1/CL_AGWRESTAPI`¶

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->importrestapi(
  it_parameters = 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 = '5347567362473873563239796247513D'
  iv_failonwarnings = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_id( ).
  lv_string = lo_result->get_name( ).
  lv_string = lo_result->get_description( ).
  lv_timestamp = lo_result->get_createddate( ).
  lv_string = lo_result->get_version( ).
  LOOP AT lo_result->get_warnings( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_binarymediatypes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_nullableinteger = lo_result->get_minimumcompressionsize( ).
  lv_apikeysourcetype = lo_result->get_apikeysource( ).
  lo_endpointconfiguration = lo_result->get_endpointconfiguration( ).
  IF lo_endpointconfiguration IS NOT INITIAL.
    LOOP AT lo_endpointconfiguration->get_types( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_endpointtype = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_ipaddresstype = lo_endpointconfiguration->get_ipaddresstype( ).
    LOOP AT lo_endpointconfiguration->get_vpcendpointids( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_string = lo_result->get_policy( ).
  LOOP AT lo_result->get_tags( ) into ls_row_4.
    lv_key = ls_row_4-key.
    lo_value = ls_row_4-value.
    IF lo_value IS NOT INITIAL.
      lv_string = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_boolean = lo_result->get_disableexecuteapiendpt( ).
  lv_string = lo_result->get_rootresourceid( ).
  lv_securitypolicy = lo_result->get_securitypolicy( ).
  lv_endpointaccessmode = lo_result->get_endpointaccessmode( ).
  lv_apistatus = lo_result->get_apistatus( ).
  lv_string = lo_result->get_apistatusmessage( ).
ENDIF.

/AWS1/IF_AGW=>IMPORTRESTAPI()¶