Delete

[POST] .../v1/widget/delete

Deletes widgets. Soft-delete one or more widgets from editable dashboards. The request body is a required array; every item must contain a positive widget id and each widget is checked against its dashboard ownership, dashboard all-delete permission, system dashboard protection and fixed-dashboard restriction. The method marks all requested widget rows deleted in one transaction and returns row_affected with the deleted ids. Errors such as missing or empty array body, invalid ids, missing widgets or dashboards, denied access, system or fixed dashboard restrictions, storage errors, no affected rows are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Record ID.

Request Example

[
  {
    "id": 15
  },
  {
    "id": 16
  }
]

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 2,
    "ids": [
      15,
      16
    ]
  }
}