Base properties

Learn about the base properties and their examples.

Attribute Required on create Data type Description Example link
identifier true String A unique identifier for the widget definition within the tenant  
lastModifiedDate false Date The timestamp in UTF when the widget was last updated. Cannot be set from an API.  
lastModifiedBy false String A unique identifier of the user who last updated the widget definition. Cannot be set from an API.  
description false Object On a GET request, the description of the widget definition is returned in the user's current language or default language of the widget definition. description
offeringId true String The offering identifier for the widget definition.

The value must be: SCO. Possible Values: SCO

  
type true String Intended usage for the widget definition. For example, Dashboard implies that the definition is used only for dashboards. Possible Values: Dashboard, Explorer  
descriptions true Object An JSON object of language-specific descriptions for the widget definition. The name and description is used to identify the definition. descriptions
adminConfigurations false Array An array of administrative configurations for the widget definition. This section can be left empty. This section is populated based on override criteria that is set in a widget subscription document.  
path true String Not used but requires a value to be set.  
createdDate false Date The timestamp in UTF when the widget was created. Cannot be set from an API.  
defaultLanguage true String A 2-character default code that specifies the locale that is used by the widget definition. Set to your target locale for the offering, such as en.  
createdBy false String The unique identifier of the user who created the widget definition. Cannot be set from an API.  
vendor true String An identifier for the organization that created the widget definition. Set to a customer or SI acronym. This field is an informational field that is used to identify customization assets.  
userConfigurations true Array An array of user configurations for the widget definition. The intended use is to allow the user to have a list of configurable options that they can choose from to configure and personalize their widget. Chart type is important for all widgets because it defines what is shown in the visual, such as a table, KPI, or summary. Possible Values: data_table, carbon_chart, summary, grid_details, active_filters, filter, page_title, combo_box_search userConfigurations
tenantId true String Must be set to the value of your tenant ID GUID.  
id false String The unique ID for the widget definition. This value is automatically generated on a POST request.  
state true String The state of the widget. Useful to upgrading widgets. INACTIVE, ACTIVE, DEPRECATED, MARK_FOR_DELETED  
devConfigurations true Array An array of functional configurations for the widget definition. Use this section to specify most definition criteria for controlling the query, transformations, and display. devConfigurations

description example
"description":{
  "name":"Custom Dashboard Active Filters",
  "description":"Custom Dashboard Active Filters",
  "language":"en"
}
descriptions example
"descriptions":{
  "en":{
    "name":"Custom Dashboard Active Filters",
    "description":"Custom Dashboard Active Filters"
  }
}
userConfigurations example
"userConfigurations": [{
    "name": "chartType",
            "values": ["filter"],
    "description": {
        "name": "Select a visual to display the data",
                "language": "en",
                "description": "The type of visual display"
   }
}],
}
devConfigurations example
header
Attribute Meta information Data type Description Possible values
header.title widgetOption String A displayable text string to add to the top of a widget definition. Use if you set header.type to text_header or metric_header. A title can contain variables, such as Parts ({{ totalCountLabel }})
{
  "name": "header.title",
  "metaInformation": "widgetOption",
  "values": ["Average days of supply"]
}
  
header.path widgetOption String An optional link to a template page. To link to a View All template, such as MY_TEMPLATE, use the value /template/MY_TEMPLATE.
{
  "name": "header.path",
  "metaInformation": "widgetOption",
  "values": ["\/template\/DEFAULT_INVENTORY_APPROACHING_OOS_VIEW_ALL_LAYOUT_TEMPLATE"]
}
  
header.type widgetOption String The type of header to include at the top of the widget. If not specified, a header will not be displayed. 
{
  "name": "header.type",
  "metaInformation": "widgetOption",
  "values": ["metric_header"]
}
 text_header, metric_header
header.value widgetOption String A displayable text string to add to the top of a widget definition. Can be used to show the total count of results in a widget. Use if you set header.type to metric_header.
{
  "name": "header.value",
  "metaInformation": "widgetOption",
  "values": ["{{ aggregationResults[0].values[0]['numValue'] }}"]
}
  
Total attributes: 4        
icons
Attribute Meta information Data type Description Possible values
icons[0].type widgetOption String Adds a menu to the widget. 
{
  "name": "icons[0].type",
  "metaInformation": "widgetOption",
  "values": ["accordion"]
}
 kebab_menu
icons[0].options.referenceId widgetOption String Used on data explorer pages to show the current filter within the widget. The value is the name of the filter.
{
  "name": "icons[0].options.referenceId",
  "metaInformation": "widgetOption",
  "values": ["CARRIER_FILTER"]
}
  
icons[0].options[0] widgetOption String Adds a menu option. Only move is supported. icons[0].type and icons[0].options[0] might be used together.
{
  "name": "icons[0].options[0]",
  "metaInformation": "widgetOption",
  "values": ["move"]
}
 move
icons[0].options.referenceType widgetOption String Used on data explorer pages to show the current filter within the widget. This type refers to the referenceId.
{
  "name": "icons[0].options.referenceType",
  "metaInformation": "widgetOption",
  "values": ["widget_definition"]
}
 widget_definition
Total attributes: 4        
subheader
Attribute Meta information Data type Description Possible values
subheader.dateFormat widgetOption String If a subheader uses the dateTpl, then you can specify a format such as[{{ subTitle }} {{ dateRange }} as of] LT, DD MMM.].
{
  "name": "subheader.dateFormat",
  "metaInformation": "widgetOption",
  "values": ["[expiring inventory from {{ dateRange }} {{ title }} as of] LT, DD MMM."]
}
  
subheader.viewId widgetOption String Specifies the formatting template to use when displaying the sub header. Default is textTpl.
{
  "name": "subheader.viewId",
  "metaInformation": "widgetOption",
  "values": ["textTpl"]
}
 numberTpl, linkTpl, textTpl, dateTpl, currencyTpl, assigneeTpl, percentTpl
subheader.label widgetOption String A label for the sub header is the value that will be displayed. It can be a text string that includes variables. For the current time use {{ now }}.
{
  "name": "subheader.label",
  "metaInformation": "widgetOption",
  "values": ["{{ selectedType }} Line {{ selectedId }}"]
}
  
subheader.filterData widgetOption String Another optional header display field that can show text or a variable. Used in cases where the widget shows applied filters. Example: {{ partsShortViewAll.appliedFilters }}
{
  "name": "subheader.filterData",
  "metaInformation": "widgetOption",
  "values": ["{{ partsShortViewAll.appliedFilters }}"]
}
  
subheader.type widgetOption String The type of sub header to include at the top of the widget. If not specified, a sub header will not be displayed.
{
  "name": "subheader.type",
  "metaInformation": "widgetOption",
  "values": ["template"]
}
 template
Total attributes: 5        
Footer
Attribute Meta information Data type Description Possible values
widget.footer.href.labelOptions.icon widgetOption String If an iconTpl is used, then this value specifies the name of the Carbon icon to display, such as arrow--right.
{
  "name": "widget.footer.href.labelOptions.icon",
  "metaInformation": "widgetOption",
  "values": ["arrow--right"]
}
  
widget.footer.customTemplate widgetOption String The footer display template. Typically a link that uses the template linkTpl. If a link, the type and ID must be specified.
{
  "name": "widget.footer.customTemplate",
  "metaInformation": "widgetOption",
  "values": ["linkTpl"]
}
 linkTpl, textTpl
widget.footer.href.id widgetOption String The entity to link to. If widget.footer.href.type specifies LAYOUT_TEMPLATE, then the value here might be the LAYOUT_TEMPLATE identifier, for example, MY_TEMPLATE
{
  "name": "widget.footer.href.id",
  "metaInformation": "widgetOption",
  "values": ["default_work_queues_layout"]
}
  
widget.footer.href.context widgetOption String The context of the link. The link can direct to a work queue of the layout template.
{
  "name": "widget.footer.href.context",
  "metaInformation": "widgetOption",
  "values": ["WORK_QUEUE"]
}
 WORK_QUEUE, CUI_SHELL, LAYOUT_TEMPLATE, LAYOUT
widget.footer.href.labelType widgetOption String The type of footer visual. Typically text or an icon. The default is textTpl.
{
  "name": "widget.footer.href.labelType",
  "metaInformation": "widgetOption",
  "values": ["iconTpl"]
}
 iconTpl, textTpl
widget.footer.href.type widgetOption String A key that specifies the type of entity you want to link to. 
{
  "name": "widget.footer.href.type",
  "metaInformation": "widgetOption",
  "values": ["LAYOUT_TEMPLATE"]
}
 LAYOUT_TEMPLATE
widget.footer.href.labelOptions.size widgetOption String Specifies the size of the footer text.
{
  "name": "widget.footer.href.labelOptions.size",
  "metaInformation": "widgetOption",
  "values": ["sm"]
}
 sm, md, lg, xlg
widget.footer.label widgetOption String A text label to display on the footer. 
{
  "name": "widget.footer.label",
  "metaInformation": "widgetOption",
  "values": ["View all"]
}
 true, false
showFooter tableOption Boolean Display or hide the footer of the widget.
{
  "name": "showFooter",
  "metaInformation": "tableOption",
  "values": [false]
}
 true, false
Total attributes: 9