View

Describes the configuration of a view to be displayed on the dashboard.


Properties

integer
_create_time Optional

Timestamp of resource creation


string
_create_user Optional

ID of the user who created this resource


integer
_last_modified_time Optional

Timestamp of last modification


string
_last_modified_user Optional

ID of the user who last modified this resource


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_protection Optional

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.


integer
_revision Optional

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.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


string
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


string
exclude_roles Optional

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.


string
id Optional

Unique identifier of this resource


string
include_roles Optional

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.


string
resource_type Optional

The type of this resource.


boolean
shared Optional

Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.


array of Tag
tags Optional

Opaque identifiers meaningful to the API user


integer
weight Optional

Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.


array of WidgetItem
widgets Optional

Array of widgets that are part of the view.

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"
        }
    ]
}
Feedback

Was this page helpful?