GETDASHBOARD()`¶

About GetDashboard¶

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Returns the specified dashboard.

Method Signature¶

METHODS /AWS1/IF_TRL~GETDASHBOARD
  IMPORTING
    !IV_DASHBOARDID TYPE /AWS1/TRLDASHBOARDARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trlgetdashboardrsp
  RAISING
    /AWS1/CX_TRLRESOURCENOTFOUNDEX
    /AWS1/CX_TRLUNSUPPORTEDOPEX
    /AWS1/CX_TRLCLIENTEXC
    /AWS1/CX_TRLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_dashboardid` `TYPE /AWS1/TRLDASHBOARDARN` `/AWS1/TRLDASHBOARDARN`¶

The name or ARN for the dashboard.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trlgetdashboardrsp` `/AWS1/CL_TRLGETDASHBOARDRSP`¶

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->getdashboard( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_dashboardarn = lo_result->get_dashboardarn( ).
  lv_dashboardtype = lo_result->get_type( ).
  lv_dashboardstatus = lo_result->get_status( ).
  LOOP AT lo_result->get_widgets( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_queryalias = lo_row_1->get_queryalias( ).
      lv_querystatement = lo_row_1->get_querystatement( ).
      LOOP AT lo_row_1->get_queryparameters( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_queryparameter = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_viewproperties( ) into ls_row_4.
        lv_key = ls_row_4-key.
        lo_value = ls_row_4-value.
        IF lo_value IS NOT INITIAL.
          lv_viewpropertiesvalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lo_refreshschedule = lo_result->get_refreshschedule( ).
  IF lo_refreshschedule IS NOT INITIAL.
    lo_refreshschedulefrequenc = lo_refreshschedule->get_frequency( ).
    IF lo_refreshschedulefrequenc IS NOT INITIAL.
      lv_refreshschedulefrequenc_1 = lo_refreshschedulefrequenc->get_unit( ).
      lv_refreshschedulefrequenc_2 = lo_refreshschedulefrequenc->get_value( ).
    ENDIF.
    lv_refreshschedulestatus = lo_refreshschedule->get_status( ).
    lv_timeofday = lo_refreshschedule->get_timeofday( ).
  ENDIF.
  lv_date = lo_result->get_createdtimestamp( ).
  lv_date = lo_result->get_updatedtimestamp( ).
  lv_refreshid = lo_result->get_lastrefreshid( ).
  lv_errormessage = lo_result->get_lastrefreshfailurereason( ).
  lv_terminationprotectionen = lo_result->get_terminationprotectione00( ).
ENDIF.

/AWS1/IF_TRL=>GETDASHBOARD()¶