Era.Common.DataDefinition.Dashboard.DashboardsData

Description

Information about all dashboards (dashboard tabs) for one user.

Properties

Name	JsonSchemaType	Description
activeDashboard	integer	The dashboard, which should be displayed by default. Index to the [dashboards] list, starting from 0.
dashboardTabs	array of references to Era.Common.DataDefinition.Common.Uuid	UUIDs of individual dashboards. The order of this list corresponds to the order of the [dashboards] list.
dashboards	array of references to Era.Common.DataDefinition.Dashboard.Dashboard	List of dashboards.
refreshIntervals	array of references to Era.Common.DataDefinition.Dashboard.DashboardsData_RefreshInterval	Refresh intervals for individual report templates in the dashboards. This is shared for all dashboards in [dashboards], if a report template is inserted in more dashboard cells, refresh is common for all these cells.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.NetworkMessage.ConsoleApi.Dashboards.RpcGetDashboardsResponse
Era.Common.NetworkMessage.ConsoleApi.Dashboards.RpcGetDefaultDashboardsResponse
Era.Common.NetworkMessage.ConsoleApi.Dashboards.RpcModifyDashboardsRequest
Era.Common.NetworkMessage.ConsoleApi.Dashboards.RpcSetDefaultDashboardsRequest

JsonSchema

{
    "title": "Era.Common.DataDefinition.Dashboard.DashboardsData",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Dashboard.DashboardsData"
    ],
    "properties": {
        "Era.Common.DataDefinition.Dashboard.DashboardsData": {
            "$ref": "#/definitions/DashboardsData"
        }
    },
    "definitions": {
        "DashboardsData": {
            "additionalProperties": false,
            "required": [
                "activeDashboard"
            ],
            "type": "object",
            "properties": {
                "activeDashboard": {
                    "type": "integer"
                },
                "dashboardTabs": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                        }
                    ]
                },
                "dashboards": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Dashboard.Dashboard#/definitions/Dashboard"
                        }
                    ]
                },
                "refreshIntervals": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Dashboard.DashboardsData_RefreshInterval#/definitions/DashboardsData_RefreshInterval"
                        }
                    ]
                }
            }
        }
    }
}