Dashboards
This chapter focuses on services for the dashboards.
Get dashboard
A GET
to /dashboards/{id}
returns the dashboard with the given id.
Path parameters
Parameter | Description |
---|---|
|
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 |
---|---|
|
which fields of the elements should be returned (optional) |
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 190
{
"entity_type" : "DASHBOARD",
"id" : 44,
"name" : "First dashboard",
"_links" : {
"self" : {
"href" : "http://localhost:8080/api/rest/latest/custom-exports/44"
}
}
}
Response fields
Path | Type | Description |
---|---|---|
|
|
the type of the entity |
|
|
the id of the dashboard |
|
|
the name of the dashboard |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this dashboard |
Delete dashboards
A DELETE
to /dashboards/{ids}
deletes one or several dashboard(s) with the given id(s).
Path parameters
Parameter | Description |
---|---|
|
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