Skip to content

/AWS1/IF_AGW=>GETUSAGE()

About GetUsage

Gets the usage data of a usage plan in a specified time interval.

Method Signature

METHODS /AWS1/IF_AGW~GETUSAGE
  IMPORTING
    !IV_USAGEPLANID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_KEYID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_STARTDATE TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_ENDDATE TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_POSITION TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_LIMIT TYPE /AWS1/AGWNULLABLEINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwusage
  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

Required arguments:

iv_usageplanid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The Id of the usage plan associated with the usage data.

iv_startdate TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The starting date (e.g., 2016-01-01) of the usage data.

iv_enddate TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The ending date (e.g., 2016-12-31) of the usage data.

Optional arguments:

iv_keyid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The Id of the API key associated with the resultant usage data.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_agwusage /AWS1/CL_AGWUSAGE

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->getusage(
  iv_enddate = |string|
  iv_keyid = |string|
  iv_limit = 123
  iv_position = |string|
  iv_startdate = |string|
  iv_usageplanid = |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_usageplanid( ).
  lv_string = lo_result->get_startdate( ).
  lv_string = lo_result->get_enddate( ).
  LOOP AT lo_result->get_items( ) into ls_row.
    lv_key = ls_row-key.
    LOOP AT ls_row-value into lt_row_1.
      LOOP AT lt_row_1 into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_long = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDLOOP.
  ENDLOOP.
  lv_string = lo_result->get_position( ).
ENDIF.