Hub 2017.3 Help

Get Dashboard


GET <REST API URL> /dashboards/{dashboard id }?fields=string
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.


Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body


extends uuid

{ "name": string, "owner": user , "data": raw, "permission": string, "access": string, "permissions": [dashboardPermission , ...], "favorite": boolean, "ordinal": int, "id": string /* from uuid */ , "aliasIds": [string, ...] /* from uuid */ , "aliases": [alias, ...] /* from uuid */ }
Last modified: 20 November 2017