InlineWidgetConfiguration1

InlineWidgetConfiguration1
InlineWidgetConfiguration1
JSON Example
{
    "condition": "string",
    "datasources": [
        {
            "display_name": "string",
            "keystore_info": {
                "keystore": "string",
                "keystore_alias": "string",
                "keystore_phrase": "string",
                "truststore": "string"
            },
            "urls": [
                {
                    "alias": "string",
                    "keystore_info": {
                        "keystore": "string",
                        "keystore_alias": "string",
                        "keystore_phrase": "string",
                        "truststore": "string"
                    },
                    "query": "string",
                    "request_body": {},
                    "request_headers": {},
                    "request_method": "string",
                    "url": "string"
                }
            ]
        }
    ],
    "default_filter_value": [
        "DefaultFilterValue Object"
    ],
    "display_name": "string",
    "drilldown_id": "string",
    "feature_set": "FeatureSet Object",
    "filter": "string",
    "filter_value_required": false,
    "filters": [
        "string"
    ],
    "footer": "Footer Object",
    "icons": [
        "Icon Object"
    ],
    "is_drilldown": false,
    "legend": "Legend Object",
    "plot_configs": [
        "WidgetPlotConfiguration Object"
    ],
    "resource_type": "string",
    "rowspan": 0,
    "shared": false,
    "show_header": false,
    "span": 0,
    "weight": 0
}
string
condition
Optional
Constraints: maxLength: 1024

If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.

array of Datasource
datasources
Optional
Constraints: minItems: 0

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.

default_filter_value
Optional

Default filter values to be passed to datasources. This will be used when the report is requested without filter values.

string
display_name
Optional
Constraints: maxLength: 255

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

string
drilldown_id
Optional
Constraints: maxLength: 255

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.

feature_set
Optional

Represents list of features required to view the widget.

string
filter
Optional

Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.

boolean
filter_value_required
Optional
Constraints: default: true

Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.

array of string
filters
Optional

A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.

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
Optional

Represents legend that describes the entities of the widget.

plot_configs
Optional

List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.

string
resource_type
Required
Constraints: maxLength: 255

Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.

Possible values are : LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, DropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration,
integer As int32 As int32
rowspan
Optional
Constraints: minimum: 1

Represents the vertical span of the widget / container. 1 Row span is equal to 20px.

boolean
shared
Optional

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

boolean
show_header
Optional

If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.

integer As int32 As int32
span
Optional
Constraints: minimum: 1 maximum: 12

Represents the horizontal span of the widget / container.

integer As int32 As int32
weight
Optional

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