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

40169ccdec5c

widget-type-controller

Get all Widget types for specified Bundle (getBundleWidgetTypesByBundleAlias) (Deprecated)

Returns an array of Widget Type objects that belong to specified Widget Bundle.Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory.

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

get/api/widgetTypes

Query parameters

widgetsBundleIdstring required

Widget Bundle Id

pageSizeinteger required

Maximum amount of entities in a one page

pageinteger required

Sequence number of page starting from 0

textSearchstring

The case insensitive 'substring' filter based on the widget type name.

sortProperty'createdTime' | 'name' | 'deprecated' | 'tenantId'

Property of entity to sort by

sortOrder'ASC, DESC'

Sort order. ASC (ASCENDING) or DESC (DESCENDING)

tenantOnlyboolean

Optional boolean parameter indicating whether only tenant widget types should be returned

fullSearchboolean

Optional boolean parameter indicating whether search widgets by description not only by name

deprecatedFilter'ALL' | 'ACTUAL' | 'DEPRECATED'

Optional string parameter indicating whether to include deprecated widgets

widgetTypeListstring[]

A list of string values separated by comma ',' representing one of the widget type value

scadaFirstboolean

Optional boolean parameter indicating whether to fetch SCADA symbol widgets first

isSystemboolean required

System or Tenant

bundleAliasstring required

Widget Bundle alias

Response

OK

OR

Example response

{
  "data": [
    {
      "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,
      "bundles": [
        {
          "id": {
            "id": "784f394c-42b6-435a-983c-b7beff2784f9",
            "entityType": "DEVICE"
          }
        }
      ]
    }
  ]
}