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

40169ccdec5c

widget-type-controller

Get Widget Type Details (getWidgetTypeById)

Get the Widget Type Details 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/widgetType/{widgetTypeId}

Path parameters

widgetTypeIdstring required

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

Query parameters

includeResourcesboolean

Export used resources and replace resource links with resource metadata

Response

OK

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.

imagestring

Relative or external image URL. Replaced with image data URL (Base64) in case of relative URL and 'inlineImages' option enabled.

descriptionstring

Description of the widget

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}
createdTimeinteger

Timestamp of the Widget Type creation, in milliseconds

scadaboolean

Whether widget type is SCADA symbol.

versioninteger
tagsstring[]

Tags of the widget type

Example response

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