{ "opencollection": "1.0.0", "info": { "name": "ThingsBoard Admin admin-controller widget-type-controller API", "version": "4.3.0.3DEMO" }, "items": [ { "info": { "name": "widget-type-controller", "type": "folder" }, "items": [ { "info": { "name": "Get Widget Type (getWidgetType)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetType", "params": [ { "name": "isSystem", "value": "", "type": "query", "description": "System or Tenant" }, { "name": "bundleAlias", "value": "", "type": "query", "description": "Widget Bundle alias" }, { "name": "alias", "value": "", "type": "query", "description": "Widget Type alias" }, { "name": "fqn", "value": "", "type": "query", "description": "Widget Type fqn" } ] }, "docs": "Get the Widget Type by FQN. Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory.\n\nAvailable for any authorized user. " }, { "info": { "name": "Create or Update Widget Type (saveWidgetType)", "type": "http" }, "http": { "method": "POST", "url": "https://demo.thingsboard.io/api/widgetType", "params": [ { "name": "updateExistingByFqn", "value": "", "type": "query", "description": "Optional boolean parameter indicating whether to update existing widget type by FQN if present instead of creating new one" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the Widget Type. Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory. When creating the Widget Type, platform generates Widget Type Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Widget Type Id will be present in the response. Specify existing Widget Type id to update the Widget Type. Referencing non-existing Wid" }, { "info": { "name": "Get All Widget Types for Specified Bundle (getBundleWidgetTypesByBundleAlias) (Deprecated)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetTypes", "params": [ { "name": "widgetsBundleId", "value": "", "type": "query", "description": "Widget Bundle Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Maximum amount of entities in a one page" }, { "name": "page", "value": "", "type": "query", "description": "Sequence number of page starting from 0" }, { "name": "textSearch", "value": "", "type": "query", "description": "The case insensitive 'substring' filter based on the widget type name." }, { "name": "sortProperty", "value": "", "type": "query", "description": "Property of entity to sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)" }, { "name": "tenantOnly", "value": "", "type": "query", "description": "Optional boolean parameter indicating whether only tenant widget types should be returned" }, { "name": "fullSearch", "value": "", "type": "query", "description": "Optional boolean parameter indicating whether search widgets by description not only by name" }, { "name": "deprecatedFilter", "value": "", "type": "query", "description": "Optional string parameter indicating whether to include deprecated widgets" }, { "name": "widgetTypeList", "value": "", "type": "query", "description": "A list of string values separated by comma ',' representing one of the widget type value" }, { "name": "scadaFirst", "value": "", "type": "query", "description": "Optional boolean parameter indicating whether to fetch SCADA symbol widgets first" }, { "name": "isSystem", "value": "", "type": "query", "description": "System or Tenant" }, { "name": "bundleAlias", "value": "", "type": "query", "description": "Widget Bundle alias" } ] }, "docs": "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. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, { "info": { "name": "Get Widget Type Info Objects (getBundleWidgetTypesInfosByBundleAlias) (Deprecated)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetTypesInfos", "params": [ { "name": "widgetsBundleId", "value": "", "type": "query", "description": "Widget Bundle Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Maximum amount of entities in a one page" }, { "name": "page", "value": "", "type": "query", "description": "Sequence number of page starting from 0" }, { "name": "textSearch", "value": "", "type": "query", "description": "The case insensitive 'substring' filter based on the widget type name." }, { "name": "sortProperty", "value": "", "type": "query", "description": "Property of entity to sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)" }, { "name": "fullSearch", "value": "", "type": "query", "description": "Optional boolean parameter indicating whether search widgets by description not only by name" }, { "name": "deprecatedFilter", "value": "", "type": "query", "description": "Optional string parameter indicating whether to include deprecated widgets" }, { "name": "widgetTypeList", "value": "", "type": "query", "description": "A list of string values separated by comma ',' representing one of the widget type value" }, { "name": "isSystem", "value": "", "type": "query", "description": "System or Tenant" }, { "name": "bundleAlias", "value": "", "type": "query", "description": "Widget Bundle alias" } ] }, "docs": "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\n\nAvailable for any authorized user. " }, { "info": { "name": "Get All Widget Types Details for Specified Bundle (getBundleWidgetTypesDetailsByBundleAlias) (Deprecated)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetTypesDetails", "params": [ { "name": "widgetsBundleId", "value": "", "type": "query", "description": "Widget Bundle Id" }, { "name": "includeResources", "value": "", "type": "query", "description": "Export used resources and replace resource links with resource metadata" }, { "name": "isSystem", "value": "", "type": "query", "description": "System or Tenant" }, { "name": "bundleAlias", "value": "", "type": "query", "description": "Widget Bundle alias" } ] }, "docs": "Returns an array of Widget Type Details objects that belong to specified Widget Bundle.Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, { "info": { "name": "Get Widget Type Info (getWidgetTypeInfoById)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetTypeInfo/:widgetTypeId", "params": [ { "name": "widgetTypeId", "value": "", "type": "path", "description": "A string value representing the widget type id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "docs": "Get the Widget Type Info based on the provided Widget Type Id. Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, { "info": { "name": "Get All Widget Type Fqns for Specified Bundle (getBundleWidgetTypeFqns)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetTypeFqns", "params": [ { "name": "widgetsBundleId", "value": "", "type": "query", "description": "Widget Bundle Id" } ] }, "docs": "Returns an array of Widget Type fqns that belong to specified Widget Bundle.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, { "info": { "name": "Get Widget Type Details (getWidgetTypeById)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/widgetType/:widgetTypeId", "params": [ { "name": "widgetTypeId", "value": "", "type": "path", "description": "A string value representing the widget type id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" }, { "name": "includeResources", "value": "", "type": "query", "description": "Export used resources and replace resource links with resource metadata" } ] }, "docs": "Get the Widget Type Details based on the provided Widget Type Id. Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." }, { "info": { "name": "Delete Widget Type (deleteWidgetType)", "type": "http" }, "http": { "method": "DELETE", "url": "https://demo.thingsboard.io/api/widgetType/:widgetTypeId", "params": [ { "name": "widgetTypeId", "value": "", "type": "path", "description": "A string value representing the widget type id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'" } ] }, "docs": "Deletes the Widget Type. Referencing non-existing Widget Type Id will cause an error.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority." } ] } ], "bundled": true }