-
Notifications
You must be signed in to change notification settings - Fork 145
Dashboard Resource
[User Guide](User GUide) | [Web Service API](Web Service API)
#Web API Dashboard Endpoints Provides methods to authenticate users.
Endpoint | Method | Description |
---|---|---|
/dashboards | GET | Returns dashboard |
/dashboards | POST | Create dashboard |
/dashboards/dashboardId | GET | Returns a dashboard by its ID |
/dashboards/dashboardId | PUT | Updates a dashboard having the given ID |
/dashboards/dashboardId | DELETE | Deletes the dashboard having the given ID |
##Get Dashboard Information
Returns all dashboards.
Resource URL
/dashboards
Available Version
2.0
HTTP Method
GET
Query Parameters
Name | Type | Description |
---|---|---|
dashboardName | string | Dashboard name |
owner | string | Principal dashboard owner |
##Create a Dashboard
Creates a dashboard.
Resource URL
/dashboards
Available Version
2.0
HTTP Method
GET
Body Parameters
Name | Type | Description |
---|---|---|
body | dashboard | Dashboard name |
Body Response
##Get a Specific Dashboard Returns a dashboard by its ID.
Resource URL
/dashboards/{dashboardId}
Available Version
2.0
HTTP Method
GET
Path Parameter
Name | Type | Description |
---|---|---|
body | dashboardId | Dashboard ID |
##Update a Specific Dashboard
Update a dashboard having the given ID.
Resource URL
/dashboards/{dashboardId}
Available Version
2.0
HTTP Method
POST
Path Parameter
Name | Type | Description |
---|---|---|
dashboardId | biginteger |
Response body
##Delete a Specific Dashboard Deletes the dashboard having the given ID.
Resource URL
/dashboards/{dashboardId}
Available Version
2.0
HTTP Method
DELETE
Pathy Parameter
Name | Type | Description |
---|---|---|
dashboardId | biginteger |