GETDASHBOARD()`¶

About GetDashboard¶

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

You might have recently enabled an opt-in Region (Region that is disabled by default) for your account. In that Region, GetDashboard can return an access denied error for up to 24 hours after you enable the Region. This delay occurs while dashboard data propagates. The error does not indicate a problem with your permissions. Because dashboards are global, you can call GetDashboard in any other enabled Region, or retry after propagation completes.

Method Signature¶

METHODS /AWS1/IF_CWT~GETDASHBOARD
  IMPORTING
    !IV_DASHBOARDNAME TYPE /AWS1/CWTDASHBOARDNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwtgetdashboardoutput
  RAISING
    /AWS1/CX_CWTDASHBOARDNOTFNDERR
    /AWS1/CX_CWTINTERNALSVCFAULT
    /AWS1/CX_CWTINVPARAMVALUEEX
    /AWS1/CX_CWTCLIENTEXC
    /AWS1/CX_CWTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_dashboardname` `TYPE /AWS1/CWTDASHBOARDNAME` `/AWS1/CWTDASHBOARDNAME`¶

The name of the dashboard to be described.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cwtgetdashboardoutput` `/AWS1/CL_CWTGETDASHBOARDOUTPUT`¶

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_dashboardbody = lo_result->get_dashboardbody( ).
  lv_dashboardname = lo_result->get_dashboardname( ).
ENDIF.

/AWS1/IF_CWT=>GETDASHBOARD()¶