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

40169ccdec5c

widget-type-controller

Get Widget Type Info objects (getBundleWidgetTypesInfosByBundleAlias) (Deprecated)

Get the Widget Type Info objects based on the provided parameters. Widget Type Info is a lightweight object that represents Widget Type but does not contain the heavyweight widget descriptor JSON

Available for any authorized user.

get/api/widgetTypesInfos

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)

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

isSystemboolean required

System or Tenant

bundleAliasstring required

Widget Bundle alias

Response

OK

OR

Example response

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