View
Describes the configuration of a view to be displayed on the dashboard.
Properties
| 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. |
Property of
ViewList
Parameter To
Create UI View
Create UI View
Returned By
Create UI View
Get UI View
Create UI View
Extends
ManagedResource
