5.20.4 Delete dashboard definition
- Description
-
This API deletes the dashboard definition for the dashboard ID specified in URL.
If the dashboard get/list collection/deletion function for administrators is enabled, you can also remove 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, you can only remove dashboard definitions owned by the logged in JP1 user.
The following tables show the dashboard definitions that can be deleted 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‒19: Dashboard definitions that can be deleted depending on the permissions of the logged in JP1 user Privileges for JP1 Users
The dashboard get/list collection/deletion function for administrators
Enabled
Disabled
JP1 Resource Group is "*" and has JP1_Console_Admin privileges.
All dashboard definitions
Own dashboard definitions
Other than the above
Own dashboard definitions
- 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 privileges, you can also remove dashboard definitions owned by other JP1 users.
-
- API version
-
v1
- Format
-
- Request line
DELETE /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
count-of-deletions
- 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
KAJY12011-E
Failed to delete dashboard.
- Return values
-
-
When the status code is 200
The following information is returned in the response body.
Parameter name
Data type
Optional
Description
--
int
No
Returns the count of deleted dashboard definitions. If you specify a dashboard definition that does not exist or does not have view/edit permissions, 0 is returned.
(Legend) --: Not applicable
-
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:
DELETE http://immhost01:20703/im/api/v1/dashboard/uis/1
- Response:
< HTTP/1.1 200 OK < Content-Type: application/json 1