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

40169ccdec5c

widgets-bundle-controller

Create Or Update Widget Bundle (saveWidgetsBundle)

Create or update the Widget Bundle. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case. When creating the bundle, platform generates Widget Bundle Id as time-based UUID. The newly created Widget Bundle Id will be present in the response. Specify existing Widget Bundle id to update the Widget Bundle. Referencing non-existing Widget Bundle Id will cause 'Not Found' error.

Widget Bundle alias is unique in the scope of tenant. Special Tenant Id '13814000-1dd2-11b2-8080-808080808080' is automatically used if the create bundle request is sent by user with 'SYS_ADMIN' authority.Remove 'id', 'tenantId' from the request body example (below) to create new Widgets Bundle entity.

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

post/api/widgetsBundle

Request body

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 request

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

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