5.20.1 Get dashboard definition

Description

An API that retrieves dashboard definitions for a dashboard ID specified in the URL in JSON format.

If dashboard get/list collection/deletion function for administrators is enabled, you can also retrieve dashboard definitions owned by other JP1 users when JP1 resource group is "*" and you are logged in as a JP1 user with JP1_Console_Admin privileges.

If you are logged in as a JP1 user with other privileges, or if the dashboard get/list collection/deletion function for administrators is disabled, retrieve the shared or personal dashboard definitions owned by JP1 user who ran API, and the shared dashboard definitions owned by other users, in JSON format. You cannot retrieve personal dashboard definitions owned by other JP1 users. You can edit the acquired dashboard.

The following tables show the dashboard definitions that can be retrieved depending on whether dashboard get/list collection/deletion function for administrators is enabled or disabled and the privileges of the JP1 user who logged in.

For more information about dashboard get/list collection/deletion function for administrators, see 3.2.4 Dashboard Import / Export Function and Expanded Delete Function in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

For details about the dashboard definition objects that you get in the Get dashboard definition API, see 7.2.6(1) Dashboard Definition Object.

Table 5‒17: Dashboard definitions that can be retrieved based on the privileges of the JP1 user who logged in
Privileges for JP1 Users	The dashboard get/ list collection/ deletion function for administrators
Privileges for JP1 Users	Enabled	Disabled
JP1 Resource Group is "*" and has JP1_Console_Admin privileges.	All dashboard definitions	Own or shared dashboard definitions
Other than the above	Own or shared dashboard definitions	Own or shared dashboard definitions

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

When dashboard get/list collection/deletion function for administrators is enabled

If JP1 resource group is "*" and you are logged in as a JP1 user with JP1_Console_Admin privileges, you can also retrieve personal dashboard definitions owned by other JP1 users.

API version

Format

Request line

GET /application/component/apiVersion/dashboard/uis/dashboard-ID httpVersion

Request header

Follow the request header in 5.2.3 Request format.

Request message body

None

Response message body

dashboard-definition-object

Parameters

None

Status codes

The following table lists the status codes returned in response to requests.

Status code	Messages that are output	Description
`200`	--	API operation was successful.
`400`	KAJY12006-E	The corresponding dashboard does not exist. Or you specified a dashboard that does not have read permission.
`500`	KAJY12007-E	Failed to get dashboard.

Return values

When the status code is 200

The response message body returns the dashboard definition object described in 7.2.6(1) Dashboard Definition Object.
When the status code is other than 200

The exception object in the response format described in 5.2.6 Error response message is returned in the message body of the response.

Examples

Request:

GET http://immhost01:20703/im/api/v1/dashboard/uis/1

Response:

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "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\":\"CPUusage [%]\",\"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