GETEXPORT()`¶

About GetExport¶

Exports a deployed version of a RestApi in a specified format.

Method Signature¶

METHODS /AWS1/IF_AGW~GETEXPORT
  IMPORTING
    !IV_RESTAPIID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_STAGENAME TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_EXPORTTYPE TYPE /AWS1/AGWSTRING OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING OPTIONAL
    !IV_ACCEPTS TYPE /AWS1/AGWSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwexportresponse
  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_stagename` `TYPE /AWS1/AGWSTRING` `/AWS1/AGWSTRING`¶

The name of the Stage that will be exported.

`iv_exporttype` `TYPE /AWS1/AGWSTRING` `/AWS1/AGWSTRING`¶

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Optional arguments:¶

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

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

`iv_accepts` `TYPE /AWS1/AGWSTRING` `/AWS1/AGWSTRING`¶

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_agwexportresponse` `/AWS1/CL_AGWEXPORTRESPONSE`¶

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->getexport(
  it_parameters = VALUE /aws1/cl_agwmapofstrtostr_w=>tt_mapofstringtostring(
    (
      VALUE /aws1/cl_agwmapofstrtostr_w=>ts_mapofstringtostring_maprow(
        value = new /aws1/cl_agwmapofstrtostr_w( |string| )
        key = |string|
      )
    )
  )
  iv_accepts = |string|
  iv_exporttype = |string|
  iv_restapiid = |string|
  iv_stagename = |string|
).

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_contenttype( ).
  lv_string = lo_result->get_contentdisposition( ).
  lv_blob = lo_result->get_body( ).
ENDIF.

/AWS1/IF_AGW=>GETEXPORT()¶