Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

widget-type-controller

Get Widget Type Info (getWidgetTypeInfoById)

Get the Widget Type Info based on the provided Widget Type Id. Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

get/api/widgetTypeInfo/{widgetTypeId}

Path parameters

widgetTypeIdstring required

A string value representing the widget type id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the Widget Type creation, in milliseconds

fqnstring

Unique FQN that is used in dashboards as a reference widget type

namestring

Widget name used in search and UI

deprecatedboolean

Whether widget type is deprecated.

scadaboolean

Whether widget type is SCADA symbol.

versioninteger
imagestring

Base64 encoded widget thumbnail

descriptionstring

Description of the widget type

tagsstring[]

Tags of the widget type

widgetTypestring

Type of the widget (timeseries, latest, control, alarm or static)

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "WIDGET_TYPE"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "deprecated": true,
  "scada": true,
  "bundles": [
    {
      "id": {
        "id": "784f394c-42b6-435a-983c-b7beff2784f9",
        "entityType": "DEVICE"
      }
    }
  ]
}