GETAPIKEYS()`¶

About GetApiKeys¶

Gets information about the current ApiKeys resource.

Method Signature¶

METHODS /AWS1/IF_AGW~GETAPIKEYS
  IMPORTING
    !IV_POSITION TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_LIMIT TYPE /AWS1/AGWNULLABLEINTEGER OPTIONAL
    !IV_NAMEQUERY TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_CUSTOMERID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_INCLUDEVALUES TYPE /AWS1/AGWNULLABLEBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwapikeys
  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¶

Optional arguments:¶

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

The current pagination position in the paged result set.

`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.

`iv_namequery` `TYPE /AWS1/AGWSTRING` `/AWS1/AGWSTRING`¶

The name of queried API keys.

`iv_customerid` `TYPE /AWS1/AGWSTRING` `/AWS1/AGWSTRING`¶

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

`iv_includevalues` `TYPE /AWS1/AGWNULLABLEBOOLEAN` `/AWS1/AGWNULLABLEBOOLEAN`¶

A boolean flag to specify whether (true) or not (false) the result contains key values.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_agwapikeys` `/AWS1/CL_AGWAPIKEYS`¶

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->getapikeys(
  iv_customerid = |string|
  iv_includevalues = ABAP_TRUE
  iv_limit = 123
  iv_namequery = |string|
  iv_position = |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_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_items( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_string = lo_row_3->get_id( ).
      lv_string = lo_row_3->get_value( ).
      lv_string = lo_row_3->get_name( ).
      lv_string = lo_row_3->get_customerid( ).
      lv_string = lo_row_3->get_description( ).
      lv_boolean = lo_row_3->get_enabled( ).
      lv_timestamp = lo_row_3->get_createddate( ).
      lv_timestamp = lo_row_3->get_lastupdateddate( ).
      LOOP AT lo_row_3->get_stagekeys( ) 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_row_3->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.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_position( ).
ENDIF.

/AWS1/IF_AGW=>GETAPIKEYS()¶