InlineView1

JSON Example

{
    "display_name": "string",
    "exclude_roles": "string",
    "include_roles": "string",
    "shared": false,
    "weight": 0,
    "widgets": [
        {
            "alignment": "string",
            "label": {
                "condition": "string",
                "hover": false,
                "icons": [
                    {
                        "color": "string",
                        "placement": "string",
                        "size": "number",
                        "size_unit": "string",
                        "tooltip": [
                            {
                                "condition": "string",
                                "heading": false,
                                "text": "string"
                            }
                        ],
                        "type": "string"
                    }
                ],
                "navigation": "string",
                "text": "string"
            },
            "rowspan": 0,
            "separator": false,
            "span": 0,
            "weight": 0,
            "widget_id": "string"
        }
    ]
}

string

display_name

Required

Constraints: maxLength: 255

Title of the widget.

string

exclude_roles

Optional

Constraints: maxLength: 1024

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

include_roles

Optional

Constraints: maxLength: 1024

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.

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.

integer As int32 As int32

weight

Optional

Constraints: default: 10000

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

array of WidgetItem

widgets

Required

Constraints: minItems: 0

Array of widgets that are part of the view.

Used By

View