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 all dashboards.
/dashboards	POST	Create a 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	Name of the dashboard.
owner	string	The name of the principal owner of the dashboard.

##Create a Dashboard
Creates a dashboard.

Resource URL
/dashboards

Available Version
2.0

HTTP Method
GET

Body Parameters

Name	Type	Description
body	dashboard	Name of the dashboard.

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	The unique Id of the dashboard.

##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