List Widget Configurations

List Widget Configurations

If no query params are specified then all the Widget Configurations of the specified view are returned.

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

view-id

Query Parameters
string
container
Optional

Id of the container

string
widget_ids
Optional

Ids of the WidgetConfigurations


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns WidgetConfigurationList of type(s) application/json
{
    "widgetconfigurations": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "datasources": [
                {
                    "display_name": "string",
                    "urls": [
                        {
                            "alias": "string",
                            "query": "string",
                            "url": "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"
                }
            ],
            "is_drilldown": false,
            "legend": {
                "alignment": "string",
                "display_count": false,
                "position": "string",
                "type": "string"
            },
            "shared": false,
            "weight": 0
        }
    ]
}
widgetconfigurations
Optional

Array of widget configurations


400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}