5.20.2 Get dashboard definitions list

Description

An API that gets a list of dashboard definitions.

Gets an array of defined dashboard definitions (dashboard definition objects). There is no upper limit on the number of arrays to get. However, data (panel data) of the dashboard definition object is null.

If the dashboard get/list collection/deletion function for administrators is enabled, get a list including 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 permissions, or if the dashboard get/list collection/deletion function for administrators is disabled, get a list of dashboard definitions owned by the logged in JP1 user along with a list of dashboard definitions whose publishing scope is Shared.

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

For details about the 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.

Table 5‒18: Dashboard definitions available in the list depending on the permissions of JP1 user 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 ^#

#: Gets a list of dashboard definitions owned by the logged-in JP1 user along with a list of dashboard definitions whose publishing scope is Shared.

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

When the 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 operational permissions, you can get it in the list, including dashboard definitions owned by other JP1 users.

API version

Format

Request line

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

Request header

Follow the request header in 5.2.3 Request format.

Request message body

None

Response message body

array-of-dashboard-definition-objects

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.
`500`	KAJY12007-E	Failed to get dashboard.

Return values

When the status code is 200

An array of dashboard definition objects, as described in 7.2.6(1) Dashboard Definition Object is returned in the message body of the response.
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

Response:

< HTTP/1.1 200 OK
< Content-Type: application/json
[
    {
        "id": 1,
        "title": "CPU Usage Weekly Report",
        "memo": "{\"sid\":\"_ROOT_AllSystems/_HOST_HOST8150143/_CATEGORY_otherApplications/_OBJECT_JP1BASETRAP\"}",
        "data": null,
        "owner": "jp1user1",
        "scope": "protected",
        "createTime": 1710566717,
        "updateTime": 1710566717
    },
    {
        "id": 2,
        "title": "Memory Usage Weekly Report",
        "memo": "{\"sid\":\"_ROOT_AllSystems/_HOST_HOST8150143/_CATEGORY_otherApplications/_OBJECT_JP1BASETRAP\"}",
        "data": null,
        "owner": "jp1user2",
        "scope": "protected",
        "createTime": 1710566717,
        "updateTime": 1710566717
    }
]

To Page Top