Create Widget Configuration

Create Widget Configuration

Creates a new Widget Configuration and adds it to the specified view. Supported resource_types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration and ContainerConfiguration.

Note: Expressions should be given in a single line. If an expression spans multiple lines, then form the expression in a single line. For label-value pairs, expressions are evaluated as follows: a. First, render configurations are evaluated in their order of appearance in the widget config. The 'field' is evaluated at the end. b. Second, when render configuration is provided then the order of evaluation is 1. If expressions provided in condition and display value are well-formed and free of runtime-errors such as null pointers and evaluates to true; Then remaining render configurations are not evaluated, and the current render configurations 'display value' is taken as the final value. 2. If expression provided in condition of render configuration is false, then next render configuration is evaluated. 3. Finally, field is evaluated only when every render configuration evaluates to false and no error occurs during steps 1 and 2 above.

If an error occurs during evaluation of render configuration, then an error message is shown. The display value corresponding to that label is not shown and evaluation of the remaining render configurations continues to collect and show all the error messages (marked with the Label for identification) as Error_Messages: {}.

If during evaluation of expressions for any label-value pair an error occurs, then it is marked with error. The errors are shown in the report, along with the label value pairs that are error-free.

Important: For elements that take expressions, strings should be provided by escaping them with a back-slash. These elements are - condition, field, tooltip text and render_configuration's display_value.

Request
URI
POST
https://nsxmanager.your.domain/api/v1/ui-views/{view-id}/widgetconfigurations
COPY
Path Parameters
string
view-id
Required

view-id


Request Body
WidgetConfiguration of type(s) application/json
Optional
This request body class requires all of the following: ManagedResource , InlineWidgetConfiguration1
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "datasources": [
        {
            "display_name": "string",
            "urls": [
                {
                    "url": "string",
                    "alias": "string",
                    "query": "string"
                }
            ]
        }
    ],
    "weight": 0,
    "footer": {
        "condition": "string",
        "actions": [
            {
                "url": "string",
                "dock_to_container_footer": false,
                "label": {
                    "text": "string",
                    "hover": false,
                    "navigation": "string",
                    "condition": "string",
                    "icons": [
                        {
                            "placement": "string",
                            "type": "string",
                            "tooltip": [
                                {
                                    "text": "string",
                                    "condition": "string"
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "shared": false,
    "drilldown_id": "string",
    "is_drilldown": false
}
Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns WidgetConfiguration of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineWidgetConfiguration1
{
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_create_user": "string",
    "_protection": "string",
    "_create_time": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string",
    "datasources": [
        {
            "display_name": "string",
            "urls": [
                {
                    "url": "string",
                    "alias": "string",
                    "query": "string"
                }
            ]
        }
    ],
    "weight": 0,
    "footer": {
        "condition": "string",
        "actions": [
            {
                "url": "string",
                "dock_to_container_footer": false,
                "label": {
                    "text": "string",
                    "hover": false,
                    "navigation": "string",
                    "condition": "string",
                    "icons": [
                        {
                            "placement": "string",
                            "type": "string",
                            "tooltip": [
                                {
                                    "text": "string",
                                    "condition": "string"
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    },
    "shared": false,
    "drilldown_id": "string",
    "is_drilldown": false
}

400
Returns BadRequest of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


403
Returns Forbidden of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


404
Returns NotFound of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


412
Returns PreconditionFailed of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


500
Returns InternalServerError of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code


503
Returns ServiceUnavailable of type(s) application/json
{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
object
error_data
Optional

Additional data about the error

string
details
Optional

Further details about the error

array of ApiError
related_errors
Optional

Other errors related to this error

string
module_name
Optional

The module name where the error occurred

string
error_message
Optional

A description of the error

integer As int64 As int64
error_code
Optional

A numeric error code