InlineWidgetConfiguration1

InlineWidgetConfiguration1

JSON Example

{
    "datasources": [
        {
            "display_name": "string",
            "urls": [
                {
                    "alias": "string",
                    "query": "string",
                    "url": "string"
                }
            ]
        }
    ],
    "display_name": "string",
    "drilldown_id": "string",
    "footer": {
        "actions": [
            {
                "dock_to_container_footer": false,
                "label": {
                    "condition": "string",
                    "hover": false,
                    "icons": [
                        {
                            "placement": "string",
                            "tooltip": [
                                {
                                    "condition": "string",
                                    "heading": false,
                                    "text": "string"
                                }
                            ],
                            "type": "string"
                        }
                    ],
                    "navigation": "string",
                    "text": "string"
                },
                "url": "string"
            }
        ],
        "condition": "string"
    },
    "icons": [
        {
            "placement": "string",
            "tooltip": [
                {
                    "condition": "string",
                    "heading": false,
                    "text": "string"
                }
            ],
            "type": "string"
        }
    ],
    "is_drilldown": false,
    "legend": {
        "alignment": "string",
        "display_count": false,
        "position": "string",
        "type": "string"
    },
    "resource_type": "string",
    "shared": false,
    "weight": 0
}

array of Datasource

datasources

Optional

The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.

string

display_name

Optional

Title of the widget. If display_name is omitted, the widget will be shown without a title.

string

drilldown_id

Optional

Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.

Footer

footer

Optional

Footer of a widget that provides additional information or allows an action such as clickable url for navigation. An example usage of footer is provided under 'example_request' section of 'CreateWidgetConfiguration' API.

array of Icon

icons

Optional

Icons to be applied at dashboard for widgets and UI elements.

boolean

is_drilldown

Optional

Set to true if this widget should be used as a drilldown.

Legend

legend

Optional

Represents legend that describes the entities of the widget.

string

resource_type

Required

Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration.

Possible values are : LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration,

boolean

shared

Optional

Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.

integer As int32 As int32

weight

Optional

Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.

Used By

WidgetConfiguration