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

40169ccdec5c

widget-type-controller

Get Widget Type (getWidgetType)

Get the Widget Type by FQN. Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory.

Available for any authorized user.

get/api/widgetType

Query parameters

isSystemboolean required

System or Tenant

bundleAliasstring required

Widget Bundle alias

aliasstring required

Widget Type alias

fqnstring required

Widget Type fqn

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
{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

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,
  "descriptor": {}
}