GridConfiguration

Represents configuration of a Grid or Table widget.


Properties

integer
_create_time Optional

Timestamp of resource creation


string
_create_user Optional

ID of the user who created this resource


integer
_last_modified_time Optional

Timestamp of last modification


string
_last_modified_user Optional

ID of the user who last modified this resource


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_protection Optional

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.


integer
_revision Optional

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.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


array of ColumnItem
columns Optional

Array of columns of a Grid widget


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
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


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 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.


string
id Optional

Unique identifier of this resource


boolean
is_drilldown Optional

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


legend Optional

Legend to be displayed. If legend is not needed, do not include it.


integer
page_size Optional

Number of records per page. page_size will be effective only when the urls provided in the datasource support paging.


string
resource_type Optional

The type of this resource.


array of RowListField
row_list_fields Optional

Rows of grid or table are formed from the list of objects returned by a row list field.


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
span Optional

Represents the horizontal span of the Grid.


array of Tag
tags Optional

Opaque identifiers meaningful to the API user


integer
weight Optional

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

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "columns": [
        {
            "column_identifier": "string",
            "drilldown_id": "string",
            "field": "string",
            "hidden": false,
            "label": {
                "condition": "string",
                "hover": false,
                "icons": [
                    {
                        "placement": "string",
                        "tooltip": [
                            {
                                "condition": "string",
                                "heading": false,
                                "text": "string"
                            }
                        ],
                        "type": "string"
                    }
                ],
                "navigation": "string",
                "text": "string"
            },
            "navigation": "string",
            "render_configuration": [
                {
                    "color": "string",
                    "condition": "string",
                    "display_value": "string",
                    "icons": [
                        {
                            "placement": "string",
                            "tooltip": [
                                {
                                    "condition": "string",
                                    "heading": false,
                                    "text": "string"
                                }
                            ],
                            "type": "string"
                        }
                    ],
                    "tooltip": [
                        {
                            "condition": "string",
                            "heading": false,
                            "text": "string"
                        }
                    ]
                }
            ],
            "sort_ascending": false,
            "sort_key": "string",
            "tooltip": [
                {
                    "condition": "string",
                    "heading": false,
                    "text": "string"
                }
            ],
            "type": "string"
        }
    ],
    "datasources": [
        {
            "display_name": "string",
            "urls": [
                {
                    "alias": "string",
                    "query": "string",
                    "url": "string"
                }
            ]
        }
    ],
    "description": "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"
        }
    ],
    "id": "string",
    "is_drilldown": false,
    "legend": {
        "alignment": "string",
        "display_count": false,
        "position": "string",
        "type": "string"
    },
    "page_size": 0,
    "resource_type": "string",
    "row_list_fields": [
        {
            "alias": "string",
            "path": "string"
        }
    ],
    "shared": false,
    "span": 0,
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "weight": 0
}
Feedback

Was this page helpful?