Get

[POST] .../v1/widgettype/get

Returns widget types. Use this read-only method to populate widget creation forms before calling Widget/Add. The method returns active widget type records ordered by id, including translated display name, untranslated name_key, translated description and last update time. The action does not require a request body, does not perform a separate permission check and any body content is ignored by the current implementation. Business errors such as database read failures, empty persistent results and translation lookup failures are returned as HTTP 200 ErrorResult.

Request Parameters

No request body.

Request Example

{}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of WidgetType Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 6,
      "name": "Retail sale stats",
      "name_key": "RETAIL_SALE_STATS",
      "description": "Retail sale statistics",
      "last_update": 0
    },
    {
      "id": 19,
      "name": "Integration",
      "name_key": "INTEGRATION",
      "description": "External integration chart",
      "last_update": 0
    }
  ]
}