View
Describes the configuration of a view to be displayed on the dashboard.
Properties
Timestamp of resource creation
ID of the user who created this resource
Timestamp of last modification
ID of the user who last modified this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
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.
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 for this resource
Indicates system owned resource
Description of this resource
Defaults to ID if not set
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.
Unique identifier of this resource
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.
The type of this resource.
Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.
Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.
Property Of
ViewList
Parameter To
Create UI VIew
Create UI VIew
Returned By
Create UI VIew
Create UI VIew
Get UI VIew
Extends
ManagedResource
JSON Example
{
"_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"
}
]
}
