Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Dashboard Resource

Lauren Padia edited this page Mar 22, 2017 · 4 revisions

User Guide | Web Service API


Web API Dashboard Endpoints

Provides methods for dashboards.

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
Clone this wiki locally