Hub 2019.1 Help

Create New Dashboard

Request

POST <REST API URL>/dashboards?fields=string

Parameter

Description

fields

Optional. Returns only the specified subset of the fields for each Dashboard. Use Fields Syntax to define the subset.

Request Body

dashboard

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 */ }

Response

Response Code

Meaning

200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "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: 17 February 2020