[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
List Widget Configurations
DescriptionIf no query params are specified then all the Widget Configurations of the specified view are returned.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/ui-views/{view-id}/widgetconfigurations
Path Parameters
Path Parameters
string
view-id
Required
Query Parameters
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.
Response
Response
Response BodyResponse Body
200 OK
Returns
WidgetConfigurationList
of type(s) application/json
{
"widgetconfigurations": [
{
"_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": "PRE",
"tooltip": [
{
"condition": "string",
"heading": false,
"text": "string"
}
],
"type": "ERROR"
}
],
"navigation": "string",
"text": "string"
},
"url": "string"
}
],
"condition": "string"
},
"icons": [
{
"placement": "PRE",
"tooltip": [
{
"condition": "string",
"heading": false,
"text": "string"
}
],
"type": "ERROR"
}
],
"id": "string",
"is_drilldown": false,
"legend": {
"alignment": "HORIZONTAL",
"display_count": false,
"position": "TOP",
"type": "CIRCLE"
},
"resource_type": "LabelValueConfiguration",
"shared": false,
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"weight": 0
}
]
}
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/ui-views/{view-id}/widgetconfigurations
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list-widget-configurations
x-vmw-nsx-module: NsxDashboard
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
