ContainerConfiguration
Represents a container to group widgets that belong to a common category or have a common purpose.
Properties
| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | _create_time | integer |
Timestamp of resource creation |
| optional | _create_user | string |
ID of the user who created this resource |
| optional | _last_modified_time | integer |
Timestamp of last modification |
| optional | _last_modified_user | string |
ID of the user who last modified this resource |
| optional | _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| optional | _protection | string |
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. |
| optional | _revision | integer |
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. |
| optional | _schema | string |
Schema for this resource |
| optional | _self | SelfResourceLink |
Link to this resource |
| optional | _system_owned | boolean |
Indicates system owned resource |
| optional | datasources | array of Datasource |
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. |
| optional | description | string |
Description of this resource |
| optional | display_name | string |
Defaults to ID if not set |
| optional | drilldown_id | string |
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. |
| optional | footer | Footer |
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. |
| optional | icons | array of Icon |
Icons to be applied at dashboard for widgets and UI elements. |
| optional | id | string |
Unique identifier of this resource |
| optional | is_drilldown | boolean |
Set to true if this widget should be used as a drilldown. |
| optional | labels | array of Label |
Labels for the container. |
| optional | layout | Layout |
Layout of widgets can be either vertical or horizontal. If layout is not specified a default horizontal layout is applied. |
| optional | legend | Legend |
Legend to be displayed. If legend is not needed, do not include it. |
| optional | navigation | string |
Hyperlink of the specified UI page that provides details. |
| optional | resource_type | string |
The type of this resource. |
| optional | shared | boolean |
Please use the property ‘shared’ of View instead of this. The widgets of a shared view are visible to other users. |
| optional | span | integer |
Represents the horizontal span of the container. |
| optional | tags | array of Tag |
Opaque identifiers meaningful to the API user |
| optional | weight | integer |
Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details. |
| optional | widgets | array of WidgetItem |
If not specified, creates an empty container. |
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,
"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,
"labels": [
{
"condition": "string",
"hover": false,
"icons": [
{
"placement": "string",
"tooltip": [
{
"condition": "string",
"heading": false,
"text": "string"
}
],
"type": "string"
}
],
"navigation": "string",
"text": "string"
}
],
"layout": {
"properties": {
"num_columns": 0,
"num_rows": 0
},
"type": "string"
},
"legend": {
"alignment": "string",
"display_count": false,
"position": "string",
"type": "string"
},
"navigation": "string",
"resource_type": "string",
"shared": false,
"span": 0,
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"weight": 0,
"widgets": [
{
"alignment": "string",
"label": {
"condition": "string",
"hover": false,
"icons": [
{
"placement": "string",
"tooltip": [
{
"condition": "string",
"heading": false,
"text": "string"
}
],
"type": "string"
}
],
"navigation": "string",
"text": "string"
},
"separator": false,
"weight": 0,
"widget_id": "string"
}
]
}
