Methods
(route) create(:id)
Route:
| Method | Path |
|---|
| PUT |
/api/bucket/:id/dashboardSchema/ |
Create a dashboard of a bucket
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| name |
String |
the name of the dashboard |
| data |
Object |
the list of component that compose the dashboard |
| mode |
String |
the dashboard mode |
| image |
Object |
background image for the dashboard |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
Response:
| Name |
Type |
Description |
| . |
Dashboard |
complete dashboard object from database |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully created dashboard |
| 400 |
Invalid params |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) remove(:id, :dashid)
Route:
| Method | Path |
|---|
| DELETE |
/api/bucket/:id/dashboardSchema/:dashid |
Remove a dashboard from a bucket
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :dashid |
String |
dashboard id |
Response:
| Name |
Type |
Description |
| . |
Array |
array of dashboards |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully deleted dashboard |
| 400 |
Invalid params |
| 404 |
dashboard not found |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:dashid |
|
dashboard id |
(route) retrieve(:id, :dashid)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/dashboardSchema/:dashid |
Retrieve dashboards of a bucket
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :dashid |
String |
dashboard id |
Response:
| Name |
Type |
Description |
| . |
Array |
array of dashboards |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 404 |
dashboard not found |
| 400 |
Invalid params |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:dashid |
|
dashboard id |
(route) retrieveAll(:id)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/dashboardSchema/ |
Retrieve dashboards of a bucket
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
Response:
| Name |
Type |
Description |
| . |
Array |
array of servers status |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 400 |
Invalid params |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) update(:id, :dashId)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/dashboardSchema/:dashId |
Update a dashboard of a bucket
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| name |
String |
the name of the dashboard |
| data |
Object |
the data to populate the dashboard |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :dashId |
String |
dashboard id |
Response:
| Name |
Type |
Description |
| . |
Array |
array of servers status |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 404 |
dashboard not found |
| 400 |
Invalid params |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:dashId |
|
dashboard id |
(route) visualization(:id, :dashid)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/dashboardSchema/:dashid/visualization |
Retrieve vizualization for dashboard
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :dashid |
String |
dashboard id |
Response:
| Name |
Type |
Description |
| . |
Array |
array of dashboards |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully retrieved data |
| 404 |
dashboard not found |
| 400 |
Invalid params |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:dashid |
|
dashboard id |