UPDATEDASHBOARD()`¶

About UpdateDashboard¶

Updates an IoT SiteWise Monitor dashboard.

Method Signature¶

METHODS /AWS1/IF_IOS~UPDATEDASHBOARD
  IMPORTING
    !IV_DASHBOARDID TYPE /AWS1/IOSID OPTIONAL
    !IV_DASHBOARDNAME TYPE /AWS1/IOSNAME OPTIONAL
    !IV_DASHBOARDDESCRIPTION TYPE /AWS1/IOSDESCRIPTION OPTIONAL
    !IV_DASHBOARDDEFINITION TYPE /AWS1/IOSDASHBOARDDEFINITION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IOSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosupdatedashboardrsp
  RAISING
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_dashboardid` `TYPE /AWS1/IOSID` `/AWS1/IOSID`¶

The ID of the dashboard to update.

`iv_dashboardname` `TYPE /AWS1/IOSNAME` `/AWS1/IOSNAME`¶

A new friendly name for the dashboard.

`iv_dashboarddefinition` `TYPE /AWS1/IOSDASHBOARDDEFINITION` `/AWS1/IOSDASHBOARDDEFINITION`¶

The new dashboard definition, as specified in a JSON literal.

IoT SiteWise Monitor (Classic) see Create dashboards (CLI)

IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)

in the IoT SiteWise User Guide

Optional arguments:¶

`iv_dashboarddescription` `TYPE /AWS1/IOSDESCRIPTION` `/AWS1/IOSDESCRIPTION`¶

A new description for the dashboard.

`iv_clienttoken` `TYPE /AWS1/IOSCLIENTTOKEN` `/AWS1/IOSCLIENTTOKEN`¶

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosupdatedashboardrsp` `/AWS1/CL_IOSUPDATEDASHBOARDRSP`¶

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->updatedashboard(
  iv_clienttoken = |string|
  iv_dashboarddefinition = |string|
  iv_dashboarddescription = |string|
  iv_dashboardid = |string|
  iv_dashboardname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_IOS=>UPDATEDASHBOARD()¶