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/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": [
        {
            "_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
        }
    ]
}
array of WidgetConfiguration
widgetconfigurations
Optional

Array of widget configurations


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

Not Found

Operation doesn't return any data structure

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


On This Page
Dashboard Operations
POST
Create View
POST
Create Widget Configuration
DELETE
Delete Widget Configuration
DELETE
Delet View
GET
Get View
GET
Get Widget Configuration
GET
List Views
GET
List Widget Configurations
PUT
Update View
PUT
Update Widget Configuration