Skip to main content

system.mes.dashboard.deleteDashboard

Description

Deletes a Dashboard by its ID.

Syntax

system.mes.dashboard.deleteDashboard(id)

Parameters

ParameterTypeNullableDescription
idString (ULID)FalseThe ID of the dashboard to delete.

Returns

If successful, an ApiResponse Object is returned with the success bool set True. If unsuccessful, an exception may be thrown.

NameTypeDescription
successBooleanIndicates if the delete was successful.
messageStringThe reason why the deletion was successful or unsuccessful.
dataStringThe data associated with the deletion.
errorStringThe errors associated with the deletion.

Code Examples

system.mes.dashboard.deleteDashboard('01JAP8RJBN-8ZTPXSGY-J9GSDPE1')