Dashboard

Create or Update User Dashboard Settings

POST
Create or Update User Dashboard Settings

Request

This endpoint expects an object.
id
stringOptional
Unique ID
userId
stringOptional
User ID
type
stringOptional
Either custom or one of DashboardType enum
reactGridLayout
objectOptional
React grid layout configuration

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
The Dashboards API is intended for use by ProjectManager
POST
$curl -X POST /api/data/dashboards/settings \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue",
12  "data": {
13    "id": "id",
14    "userId": "userId",
15    "type": "type",
16    "reactGridLayout": {
17      "lg": [
18        {}
19      ],
20      "md": [
21        {}
22      ],
23      "sm": [
24        {}
25      ],
26      "xs": [
27        {}
28      ],
29      "xxs": [
30        {}
31      ]
32    }
33  }
34}
Built with