7.2.6 Dashboard

(1) Dashboard Definition Object

Function

An object that represents information about a dashboard definition.

Type

{
    "id": ID,
    "title": Titled,
    "memo": Tree SID,
    "data": Panels,
    "owner": owner,
    "scope": public scope,
    "createTime": Creation date and time,
    "updateTime": Updated time
}

When specifying a character string in the above definition, if you want to include """, "{", "}", "[", "]", and "\" as regular characters, use "\"", "\{", "\}", "\[", "\]", and "\\".

Member

Members are listed in the following table.

Table 7‒27: Dashboard definition object members

Item number	Member	Data type	Description
1	id	int	Dashboard ID
2	title	string	Dashboard Title
3	memo	string	Specifies the additional dashboard information in JSON format. The membership specified as additional data is sid. Specifies the tree SID of IM management node associated with the dashboard in the following format: {\"sid\":\" Tree SID \"
4	data	string	A JSON-formatted string representing the panel's data For more information, see Table 7-28.
5	owner	string	JP1 username that is the owner of the dashboard
6	scope	string	String indicating the public scope "protected" for "Share" or "private" for "Person" is specified.

Table 7‒28: Members of data

Item number	Member		Data type	Description
1	panels		Array	Array of objects representing the panel information
2	-		object	Objects that represent panel information
3		type	string	Panel Type Can be one of the following: trend Trends ranking Ranking numeric Numeric gauge Gauge alert Alert information nodeState Node state nodeStateMap Node state map text Text
4		options	object	An object that represents the display options of the panel. The content of the object varies from panel to panel. For more information, see Table 7-29, Table 7-30, Table 7-31, and Table 7-32. Note that the contents of the object when the panel type is text are not exposed.

Table 7‒29: Members of options (Panel Type: Trend)

Item number	Member		Data type	Description
1	y		object	Objects representing Display options on the y-axis
2		sidPattern	Array	Array of tree SID of Target node

Table 7‒30: Members of options (Panel Type: Ranking, Number, Gauge, Alert Information)

Item number	Member	Data type	Description
1	sidPattern	Array	Array of tree SID of Target node

Table 7‒31: Members of options (Panel Type: Node state)

Item number	Member	Data type	Description
1	sid	string	Target node Tree SID

Table 7‒32: Members of options (Panel Type: Node state map)

Item number	Member	Data type	Description
1	nodes	Array	Array of node objects For the members of the node object, see Table 7-33.

Table 7‒33: Node object members (Panel Type: Node state map)

Item number	Member	Data type	Description
1	sid	string	Target node Tree SID

Output example

{
    "id": 1,
    "title": "Weekly Report",
    "memo": "{\"sid\":\"_ROOT_AllSystems/_HOST_HISOL8150143/_CATEGORY_otherApplications/_OBJECT_JP1BASETRAP\"}",
    "data": "{\"cols\":4, \"panels\":[{\"title\":\"CPU usage\",\"type\":\"trend\",\"options\":{\"y\":{\"sidPattern\":[\"_ROOT_AllSystems/_SYSTEM_systemA/_HOST_HISOL8152841/_CATEGORY_platform/_OBJECT_JP1PC-AWindows%20metric%20collector%28Windows%20exporter%29\"],\"metric\":\"cpu_used_rate\",\"type\":\"line\",\"legend\":\"bottom\",\"fill\":false,\"stacked\":false,\"grid\":true,\"min\":null,\"max\":null,\"pointRadius\":1,\"plot\":60,\"approximate\":true}},\"id\":\"3568cefa-b672-4b14-b847-263d7d065506\",\"x\":0,\"y\":0,\"w\":1,\"h\":1,\"i\":\"0\",\"displayData\":{\"yTitle\":\"CPU usage [%]\",\"y2Title\":\"\",\"datasetY\":[{\"type\":\"line\",\"label\":\"HISOL8152841\",\"tooltipLabel\":\"HISOL8152841 > Platform > Windows metric collector(Windows exporter)\",\"sid\":\"_ROOT_AllSystems/_SYSTEM_systemA/_HOST_HISOL8152841/_CATEGORY_platform/_OBJECT_JP1PC-AWindows%20metric%20collector%28Windows%20exporter%29\",\"tooltip\":{\"enabled\":false,\"mode\":\"single\",\"callbacks\":{}},\"data\":[{\"x\":\"2024-12-09T03:55:19.000Z\",\"y\":null},{\"x\":\"2024-12-10T01:52:55.000Z\",\"y\":36.7567584459741},{\"x\":\"2024-12-10T02:17:19.000Z\",\"y\":2.1809895833333286},{\"x\":\"2024-12-10T02:41:43.000Z\",\"y\":1.879875081251356},{\"x\":\"2024-12-10T03:06:07.000Z\",\"y\":1.6617952200796822},{\"x\":\"2024-12-10T03:30:31.000Z\",\"y\":2.1875},{\"x\":\"2024-12-10T03:54:55.000Z\",\"y\":6.233068683837615},{\"x\":\"2024-12-10T03:55:19.000Z\",\"y\":null}],\"borderWidth\":2,\"fill\":false,\"stack\":false,\"yAxisID\":\"y\",\"pointRadius\":1,\"spanGaps\":1464000}],\"datasetY2\":[]},\"moved\":false,\"static\":false}]}",
    "owner": "jp1test2",
    "scope": "protected",
    "createTime": 1710566717,
    "updateTime": 1710566717
}

To Page Top