[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

List UI Views

Description

If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views.

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/ui-views
Copy

Query Parameters

Query Parameters

string
tag Optional

The tag for which associated views to be queried.


string
view_ids Optional

Ids of the Views


string
widget_id Optional

Id of widget configuration


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ViewList of type(s) application/json
{
	"views": [
		{
			"_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,
			"description": "string",
			"display_name": "string",
			"exclude_roles": "string",
			"id": "string",
			"include_roles": "string",
			"resource_type": "string",
			"shared": false,
			"tags": [
				{
					"scope": "string",
					"tag": "string"
				}
			],
			"weight": 0,
			"widgets": [
				{
					"alignment": "LEFT",
					"label": {
						"condition": "string",
						"hover": false,
						"icons": [
							{
								"placement": "PRE",
								"tooltip": [
									{
										"condition": "string",
										"heading": false,
										"text": "string"
									}
								],
								"type": "ERROR"
							}
						],
						"navigation": "string",
						"text": "string"
					},
					"separator": false,
					"weight": 0,
					"widget_id": "string"
				}
			]
		}
	]
}
array of View
views Optional

Array of views

Errors

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

Code Samples

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/ui-views
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list-ui-views
x-vmw-nsx-module: NsxDashboard


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Feedback

Was this page helpful?