Dashboards

This chapter focuses on services for the dashboards.

get Get dashboard

A GET to /dashboards/{id} returns the dashboard with the given id.

Path parameters

Table 1. /api/rest/latest/dashboards/{id}
Parameter Description

id

the id of the dashboard

HTTP request

GET /api/rest/latest/dashboards/44 HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

fields

which fields of the elements should be returned (optional)

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 76

{
  "entity_type" : "DASHBOARD",
  "id" : 44,
  "name" : "First dashboard"
}

Response fields

Path Type Description

entity_type

String

the type of the entity

id

Number

the id of the dashboard

name

String

the name of the dashboard

Snippet links not found for operation::RestReportingControllerIT/get-dashboard

delete Delete dashboards

A DELETE to /dashboards/{ids} deletes one or several dashboard(s) with the given id(s).

Path parameters

Table 1. /api/rest/latest/dashboards/{ids}
Parameter Description

ids

the list of ids of the dashboards

HTTP request

DELETE /api/rest/latest/dashboards/169,189 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080