NSX-T Data Center REST API
GraphConfiguration (type)
{
"additionalProperties": false,
"description": "Represents configuration of a graph widget",
"extends": {
"$ref": "WidgetConfiguration
},
"id": "GraphConfiguration",
"module_id": "NsxDashboard",
"nsx_feature": "NsxDashboardWidgetConfig",
"polymorphic-type-descriptor": {
"type-identifier": "GraphConfiguration"
},
"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"
},
"axes": {
"$ref": "Axes,
"desription": "Represents the Axes of a graph. If axes is not specified, labels are not applied to the axes.",
"title": "Axes of a graph"
},
"condition": {
"description": "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.",
"maxLength": 1024,
"title": "Expression for evaluating condition",
"type": "string"
},
"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"
},
"display_x_value": {
"default": false,
"description": "If true, value of a point is shown as label on X axis. If false, value of point is not shown as label on X axis. false can be useful in situations where there are too many points and showing the X value as label can clutter the X axis.",
"title": "Show or hide the value of a point on X axis",
"type": "boolean"
},
"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": {
"deprecated": true,
"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. This field is deprecated instead use 'filters' property.",
"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"
},
"filters": {
"description": "A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.",
"items": {
"type": "string"
},
"title": "A List of filter ids applied to this widget configuration",
"type": "array"
},
"footer": {
"$ref": "Footer
},
"graphs": {
"decription": "Array of graphs to be plotted on the Axes. If more than 1 graph needs to be shown on the same axes, each graph will be distinguished by its color and legend.",
"items": {
"$ref": "GraphDefinition
},
"minItems": 1,
"required": true,
"title": "Graphs",
"type": "array"
},
"graphs_colors": {
"description": "An array of graphs colors which will be applied to each graph seperately. if number of provided colors are smaller than number of graph in the widget then colors are applied in circular manner.",
"items": {
"type": "string"
},
"title": "A colors for the graph",
"type": "array"
},
"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"
},
"legend": {
"$ref": "Legend,
"description": "Legend to be displayed. If legend is not needed, do not include it.",
"title": "Legend for the widget"
},
"line_chart_plot_configs": {
"description": "List of line chart plotting configuration. This plotting configuration will be applicable for the LINE_GRAPH only.",
"items": {
"$ref": "LineChartPlotConfiguration
},
"required": false,
"title": "List of line chart plotting configuration",
"type": "array"
},
"navigation": {
"description": "Hyperlink of the specified UI page that provides details.",
"title": "Navigation to a specified UI page",
"type": "string"
},
"plot_configs": {
"description": "List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.",
"items": {
"$ref": "WidgetPlotConfiguration
},
"required": false,
"title": "List of plotting configuration for a given widget.",
"type": "array"
},
"resource_type": {
"description": "Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.",
"enum": [
"LabelValueConfiguration",
"DonutConfiguration",
"MultiWidgetConfiguration",
"ContainerConfiguration",
"StatsConfiguration",
"GridConfiguration",
"GraphConfiguration",
"CustomWidgetConfiguration",
"CustomFilterWidgetConfiguration",
"TimeRangeDropdownFilterWidgetConfiguration",
"DropdownFilterWidgetConfiguration",
"SpacerWidgetConfiguration",
"LegendWidgetConfiguration"
],
"maxLength": 255,
"readonly": true,
"required": true,
"title": "Widget visualization type",
"type": "string"
},
"rowspan": {
"description": "Represents the vertical span of the widget / container. 1 Row span is equal to 20px.",
"minimum": 1,
"title": "Vertical span",
"type": "int"
},
"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"
},
"show_header": {
"description": "If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.",
"title": "This decides to show the container header or not.",
"type": "boolean"
},
"span": {
"description": "Represents the horizontal span of the widget / container.",
"maximum": 12,
"minimum": 1,
"title": "Horizontal span",
"type": "int"
},
"sub_type": {
"default": "BAR_GRAPH",
"description": "Describes the the type of graph. LINE_GRAPH shows a line graph chart BAR_GRAPH shows a simple bar graph chart STACKED_BAR_GRAPH shows a stacked bar graph chart",
"enum": [
"LINE_GRAPH",
"BAR_GRAPH",
"STACKED_BAR_GRAPH"
],
"title": "Subtype of a graph",
"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"
},
"x_value_type": {
"default": "string",
"description": "x value type.",
"enum": [
"string",
"number",
"date",
"millisecond",
"second"
],
"required": false,
"title": "x value type",
"type": "string"
},
"y_value_type": {
"description": "y value type.",
"enum": [
"integer",
"double"
],
"required": false,
"title": "y value type",
"type": "string"
}
},
"title": "Graph Configuration",
"type": "object"
}