WidgetType Type Definition

[This topic is pre-release documentation and is subject to change.]

A widget represents the UI object used to display aggregated, calculated, or entity-specific (e.g. about a Profile) information.

WidgetType properties

Property names appended with asterisks* are required.

Property JSON type Description
widgetTypeName* string Name of the widget type (readonly)
definition* string Definition of the widget type
displayName Map Localized display names for the widget type
description string Description for the wiget
tenantId string Hub Identifier (readonly)
imageUrl string Image URL for widget type
created DateTime Time when widget type was created (readonly)
changed DateTime Time when widget type was last modified (readonly)
widgetVersion string Version of widget type

JSON example

{ 
    "widgetTypeName": "ActivityGauge",
    "tenantId": "sdktesthub",
    "displayName": {
        "en": "Activity Gauge UX"
    },
    "definition": "<widgettype definition>",
    "imageUrl": "",
    "widgetVersion": "2016-01-01"
}