Create UI VIew

Required	Parameter Name	Type	Description
required	view-id	string	Not available

{
    "_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": "string",
            "label": {
                "condition": "string",
                "hover": false,
                "icons": [
                    {
                        "placement": "string",
                        "tooltip": [
                            {
                                "condition": "string",
                                "heading": false,
                                "text": "string"
                            }
                        ],
                        "type": "string"
                    }
                ],
                "navigation": "string",
                "text": "string"
            },
            "separator": false,
            "weight": 0,
            "widget_id": "string"
        }
    ]
}

Required	Property Name	Type	Description
optional	_create_time	integer	Timestamp of resource creation
optional	_create_user	string	ID of the user who created this resource
optional	_last_modified_time	integer	Timestamp of last modification
optional	_last_modified_user	string	ID of the user who last modified this resource
optional	_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
optional	_protection	string	Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
optional	_revision	integer	The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
optional	_schema	string	Schema for this resource
optional	_self	SelfResourceLink	Link to this resource
optional	_system_owned	boolean	Indicates system owned resource
optional	description	string	Description of this resource
optional	display_name	string	Defaults to ID if not set
optional	exclude_roles	string	Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.
optional	id	string	Unique identifier of this resource
optional	include_roles	string	Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.
optional	resource_type	string	The type of this resource.
optional	shared	boolean	Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.
optional	tags	array of Tag	Opaque identifiers meaningful to the API user
optional	weight	integer	Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.
optional	widgets	array of WidgetItem	Array of widgets that are part of the view.

Response

Response Body

200 OK returns View

{
    "_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": "string",
            "label": {
                "condition": "string",
                "hover": false,
                "icons": [
                    {
                        "placement": "string",
                        "tooltip": [
                            {
                                "condition": "string",
                                "heading": false,
                                "text": "string"
                            }
                        ],
                        "type": "string"
                    }
                ],
                "navigation": "string",
                "text": "string"
            },
            "separator": false,
            "weight": 0,
            "widget_id": "string"
        }
    ]
}

Property Name	Type	Description
_create_time	integer	Timestamp of resource creation
_create_user	string	ID of the user who created this resource
_last_modified_time	integer	Timestamp of last modification
_last_modified_user	string	ID of the user who last modified this resource
_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
_protection	string	Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
_revision	integer	The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
_schema	string	Schema for this resource
_self	SelfResourceLink	Link to this resource
_system_owned	boolean	Indicates system owned resource
description	string	Description of this resource
display_name	string	Defaults to ID if not set
exclude_roles	string	Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.
id	string	Unique identifier of this resource
include_roles	string	Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.
resource_type	string	The type of this resource.
shared	boolean	Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.
tags	array of Tag	Opaque identifiers meaningful to the API user
weight	integer	Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.
widgets	array of WidgetItem	Array of widgets that are part of the view.

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"_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":"string","label":{"condition":"string","hover":false,"icons":[{"placement":"string","tooltip":[{"condition":"string","heading":false,"text":"string"}],"type":"string"}],"navigation":"string","text":"string"},"separator":false,"weight":0,"widget_id":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/ui-views/{view-id}

Errors

Code	Returns	Description
400	BadRequest	The request cannot be fulfilled due to bad syntax.
403	Forbidden	The server understood the request, but is refusing to fulfill it.
404	Nothing	The requested resource could not be found but may be available again in the future.
412	PreconditionFailed	Not available
500	InternalServerError	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	ServiceUnavailable	The server is currently unavailable (because it is overloaded or down for maintenance).

Properties Operations

post

Create UI VIew

put

Create UI VIew

delete

Delete UI VIew

get

Get UI VIew

get

List UI VIews

Create UI VIew

On This Page

Request

URL

Path Parameters

Request Body

Response

Response Body

cURL Command

Errors

On This Page

Properties Operations

Was this page helpful?