Web API for Dashboards: Difference between revisions
(Created blank page) |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Dashboards API is used to create dashboards, delete dashboards and edit dashboards properties. | |||
Note that the [[Web API for Workspace Elements|Workspace Elements API]] supports also dashboards. | |||
==Methods== | |||
The dashboards API has the following methods. | |||
<pre> | |||
GET api/dashboards GET | |||
</pre> | |||
Gets a list of all dashboards in the system (if no parameter is provided). Supports optional query parameter ''projectId'' which is project id where to get dashboards from. | |||
<pre> | |||
GET api/dashboards/{id} | |||
</pre> | |||
Gets a dashboard entity by the dashboard id. If dashboard doesn't exist, not found error is returned. If current user has no access to the dashboard, unauthorized error is returned. | |||
<pre> | |||
POST api/dashboards | |||
</pre> | |||
Creates a new empty dashboard. Takes the dashboard entity in the body (read-only properties are ignored). Returns the created dashboard entity. If current user has no rights to create dashboard, unauthorized error is returned. | |||
<pre> | |||
PUT api/dashboards/{id} | |||
</pre> | |||
Updates properties of an existing dashboard with the given id. If dashboard doesn't exist, not found error is returned. If current user has no rights to modify the dashboard, unauthorized error is returned. | |||
<pre> | |||
DELETE api/dashboards/{id} | |||
</pre> | |||
Deletes a dashboard with given id. If the dashboard doesn't exist, not found error is returned. If current user has no rights to delete the dashboard, unauthorized error is returned. | |||
<pre> | |||
GET api/dashboards/export/{id} | |||
</pre> | |||
Exports the dashboard with given id as json format. Returns the dashboard content as a stream in the PACM format. If dashboard doesn't exist, not found error is returned. If current user has no access to the dashboard, unauthorized error is returned. | |||
[[Category: QPR ProcessAnalyzer]] | |||
Latest revision as of 16:54, 27 September 2021
Dashboards API is used to create dashboards, delete dashboards and edit dashboards properties.
Note that the Workspace Elements API supports also dashboards.
Methods
The dashboards API has the following methods.
GET api/dashboards GET
Gets a list of all dashboards in the system (if no parameter is provided). Supports optional query parameter projectId which is project id where to get dashboards from.
GET api/dashboards/{id}
Gets a dashboard entity by the dashboard id. If dashboard doesn't exist, not found error is returned. If current user has no access to the dashboard, unauthorized error is returned.
POST api/dashboards
Creates a new empty dashboard. Takes the dashboard entity in the body (read-only properties are ignored). Returns the created dashboard entity. If current user has no rights to create dashboard, unauthorized error is returned.
PUT api/dashboards/{id}
Updates properties of an existing dashboard with the given id. If dashboard doesn't exist, not found error is returned. If current user has no rights to modify the dashboard, unauthorized error is returned.
DELETE api/dashboards/{id}
Deletes a dashboard with given id. If the dashboard doesn't exist, not found error is returned. If current user has no rights to delete the dashboard, unauthorized error is returned.
GET api/dashboards/export/{id}
Exports the dashboard with given id as json format. Returns the dashboard content as a stream in the PACM format. If dashboard doesn't exist, not found error is returned. If current user has no access to the dashboard, unauthorized error is returned.