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

40169ccdec5c

widgets-bundle-controller

Get Widget Bundle (getWidgetsBundleById)

Get the Widget Bundle based on the provided Widget Bundle Id. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case.

Available for any authorized user.

get/api/widgetsBundle/{widgetsBundleId}

Path parameters

widgetsBundleIdstring required

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

Query parameters

inlineImagesboolean

Inline images as a data URL (Base64)

Response

OK

createdTimeinteger

Timestamp of the Widget Bundle creation, in milliseconds

aliasstring

Unique alias that is used in widget types as a reference widget bundle

titlestring

Title used in search and UI

imagestring

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

scadaboolean

Whether widgets bundle contains SCADA symbol widget types.

descriptionstring

Description

orderinteger

Order

versioninteger
namestring

Same as title of the Widget Bundle. Read-only field. Update the 'title' to change the 'name' of the Widget Bundle.

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "WIDGETS_BUNDLE"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  }
}