{
"additionalProperties": false,
"description": "Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.",
"extends": {
"$ref": "WidgetConfiguration
},
"id": "StatsConfiguration",
"module_id": "NsxDashboard",
"nsx_feature": "NsxDashboardWidgetConfig",
"polymorphic-type-descriptor": {
"type-identifier": "StatsConfiguration"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "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.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "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.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"datasources": {
"description": "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.",
"items": {
"$ref": "Datasource
},
"minItems": 0,
"title": "Array of Datasource Instances with their relative urls",
"type": "array"
},
"default_filter_value": {
"description": "Default filter values to be passed to datasources. This will be used when the report is requested without filter values.",
"items": {
"$ref": "DefaultFilterValue
},
"title": "Default filter value to be passed to datasources",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"description": "Title of the widget. If display_name is omitted, the widget will be shown without a title.",
"maxLength": 255,
"title": "Widget Title",
"type": "string"
},
"drilldown_id": {
"description": "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.",
"maxLength": 255,
"title": "Id of drilldown widget",
"type": "string"
},
"feature_set": {
"$ref": "FeatureSet,
"description": "Features required to view the widget.",
"title": "Features required to view the widget"
},
"filter": {
"description": "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.",
"title": "Id of filter widget for subscription",
"type": "string"
},
"filter_value_required": {
"default": true,
"description": "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.",
"title": "Flag to indicate if filter value is necessary",
"type": "boolean"
},
"footer": {
"$ref": "Footer
},
"icons": {
"description": "Icons to be applied at dashboard for widgets and UI elements.",
"items": {
"$ref": "Icon
},
"title": "Icons",
"type": "array"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"is_drilldown": {
"default": false,
"description": "Set to true if this widget should be used as a drilldown.",
"title": "Set as a drilldown widget",
"type": "boolean"
},
"label": {
"$ref": "Label,
"description": "Displayed at the sections, by default. It labels the entities of sections. If label is not provided, the sections are not labelled.",
"title": "Label of the Stats Configuration"
},
"legend": {
"$ref": "Legend,
"description": "Legend to be displayed. If legend is not needed, do not include it.",
"title": "Legend for the widget"
},
"navigation": {
"description": "Hyperlink of the specified UI page that provides details.",
"maxLength": 1024,
"title": "Navigation to a specified UI page",
"type": "string"
},
"resource_type": {
"description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration and DropdownFilterWidgetConfiguration.",
"enum": [
"LabelValueConfiguration",
"DonutConfiguration",
"MultiWidgetConfiguration",
"ContainerConfiguration",
"StatsConfiguration",
"GridConfiguration",
"GraphConfiguration",
"CustomWidgetConfiguration",
"DropdownFilterWidgetConfiguration"
],
"maxLength": 255,
"readonly": true,
"required": true,
"title": "Widget visualization type",
"type": "string"
},
"sections": {
"decription": "High level logical grouping of portions or segments.",
"items": {
"$ref": "DonutSection
},
"minItems": 0,
"title": "Sections",
"type": "array"
},
"shared": {
"deprecated": true,
"description": "Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.",
"title": "Visiblity of widgets to other users",
"type": "boolean"
},
"span": {
"description": "Represents the horizontal span of the widget / container.",
"maximum": 12,
"minimum": 1,
"title": "Horizontal span",
"type": "int"
},
"stat": {
"$ref": "StatItem,
"description": "Expression that fetches statistic. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states. If stat is not provided, then it will not be displayed.",
"title": "Expression for feching statistic of an entity"
},
"sub_type": {
"description": "A sub-type of StatsConfiguration. If sub-type is not specified the parent type is rendered. The COMPACT sub_type, conserves the space for the widget. The statistic is placed on the right side on top of the status bar and the title of the widget is placed on the left side on the top of the status bar. The COMPACT style aligns itself horizontally as per the width of the container. If multiple widgets are placed insided the container then the widgets are placed one below the other to conserve the space.",
"enum": [
"COMPACT"
],
"title": "Sub-type of the StatsConfiguration",
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"weight": {
"deprecated": true,
"description": "Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.",
"title": "Weightage or placement of the widget or container",
"type": "int"
}
},
"title": "Stats Configuration",
"type": "object"
}