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

40169ccdec5c

widgets-bundle-controller

Get Widget Bundles (getWidgetsBundles)

Returns a page of Widget Bundle objects available for current user. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.

Available for any authorized user.

get/api/widgetsBundles

Query parameters

widgetsBundleIdsstring[] required

A list of widgets bundle ids, separated by comma ','

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 bundle title.

sortProperty'createdTime' | 'title' | 'tenantId'

Property of entity to sort by

sortOrder'ASC' | 'DESC'

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

tenantOnlyboolean

Optional boolean parameter to include only tenant-level bundles without system

fullSearchboolean

Optional boolean parameter indicating extended search of widget bundles by description and by name / description of related widget types

scadaFirstboolean

Optional boolean parameter indicating whether to fetch widgets bundles with SCADA symbols first. Works only when fullSearch parameter is enabled

Response

OK

OR

Example response

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