IMPORTAPIKEYS()`¶

About ImportApiKeys¶

Import API keys from an external source, such as a CSV-formatted file.

Method Signature¶

METHODS /AWS1/IF_AGW~IMPORTAPIKEYS
  IMPORTING
    !IV_BODY TYPE /AWS1/AGWBLOB OPTIONAL
    !IV_FORMAT TYPE /AWS1/AGWAPIKEYSFORMAT OPTIONAL
    !IV_FAILONWARNINGS TYPE /AWS1/AGWBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwapikeyids
  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 payload of the POST request to import API keys. For the payload format, see API Key File Format.

`iv_format` `TYPE /AWS1/AGWAPIKEYSFORMAT` `/AWS1/AGWAPIKEYSFORMAT`¶

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Optional arguments:¶

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

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_agwapikeyids` `/AWS1/CL_AGWAPIKEYIDS`¶

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->importapikeys(
  iv_body = '5347567362473873563239796247513D'
  iv_failonwarnings = ABAP_TRUE
  iv_format = |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_ids( ) 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_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.
ENDIF.

/AWS1/IF_AGW=>IMPORTAPIKEYS()¶