LabelValueConfiguration (schema)

Label Value Dashboard Widget Configuration

Represents a Label-Value widget configuration
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
datasources Array of Datasource Instances with their relative urls

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.
array of Datasource Minimum items: 0
default_filter_value Default filter value to be passed to datasources

Default filter values to be passed to datasources. This will be used when the report is requested without filter values.
array of DefaultFilterValue
description Description of this resource string Maximum length: 1024
Sortable
display_name Widget Title

Title of the widget. If display_name is omitted, the widget will be shown without a title.
string Maximum length: 255
drilldown_id Id of drilldown widget

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.
string Maximum length: 255
filter Id of filter widget for subscription

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.
string
filter_value_required Flag to indicate if filter value is necessary

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.
boolean Default: "True"
footer Footer
icons Icons

Icons to be applied at dashboard for widgets and UI elements.
array of Icon
id Unique identifier of this resource string Sortable
is_drilldown Set as a drilldown widget

Set to true if this widget should be used as a drilldown.
boolean Default: "False"
layout Layout of properties inside widget

Layout of properties can be vertical or grid. If layout is not specified a default vertical layout is applied.
Layout
legend Legend for the widget

Legend to be displayed. If legend is not needed, do not include it.
Legend
navigation Navigation to a specified UI page

Hyperlink of the specified UI page that provides details.
string Maximum length: 1024
properties Rows

An array of label-value properties.
array of PropertyItem Required
resource_type Must be set to the value LabelValueConfiguration string Required
Readonly
Enum: LabelValueConfiguration, DonutConfiguration, MultiWidgetConfiguration, ContainerConfiguration, StatsConfiguration, GridConfiguration, GraphConfiguration, CustomWidgetConfiguration, DropdownFilterWidgetConfiguration
Maximum length: 255
shared Visiblity of widgets to other users

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

Represents the horizontal span of the widget / container.
int Minimum: 1
Maximum: 12
sub_type Sub-type of the LabelValueConfiguration

A sub-type of LabelValueConfiguration. If sub-type is not specified the parent type is rendered. For VERTICALLY_ALIGNED sub_type, the value is placed below the label.
string Enum: VERTICALLY_ALIGNED
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
weight Weightage or placement of the widget or container

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