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

40169ccdec5c

widget-type-controller

Create Or Update Widget Type (saveWidgetType)

Create or update the Widget Type. Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory. When creating the Widget Type, platform generates Widget Type Id as time-based UUID. The newly created Widget Type Id will be present in the response. Specify existing Widget Type id to update the Widget Type. Referencing non-existing Widget Type Id will cause 'Not Found' error.

Widget Type fqn is unique in the scope of System or Tenant. Special Tenant Id '13814000-1dd2-11b2-8080-808080808080' is automatically used if the create request is sent by user with 'SYS_ADMIN' authority.Remove 'id', 'tenantId' rom the request body example (below) to create new Widget Type entity.

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

post/api/widgetType

Query parameters

updateExistingByFqnboolean

Optional boolean parameter indicating whether to update existing widget type by FQN if present instead of creating new one

Request body

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 request

{
  "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
}

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
}