Set Custom Dashboard Preference

Set Custom Dashboard Preference

Set upto 5 custom dashboards/OOTB dashboards as home page preference for a user

Request
URI
POST
https://{api_host}/api/ni/custom-dashboards/set-preferences
COPY
Request Body

Custom dashboard model Keys/OOTB dashboard ids in order of preference

CustomDashboardPreference of type(s) application/json
Required 
{
    "preference": [
        "mk1",
        "mk2",
        "GET_STARTED"
    ]
}
array of string
preference
Optional

Custom dashboard model keys/OOTB dashboard ids in order of preference upto a maximum of 5. GET_STARTED is the only OOTB dashboard supported.

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Operation doesn't return any data structure

400

Bad Request

Returns ApiError of type(s) application/json 
"ApiError Object"
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of object
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
"ApiError Object"
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of object
details
Optional

details


500

Internal Error

Returns ApiError of type(s) application/json 
"ApiError Object"
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of object
details
Optional

details


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/custom-dashboards/set-preferences
On This Page
Custom Dashboards Operations
GET
Get All Custom Dashboards
POST
Create Custom Dashboard
GET
Get Custom Dashboard
PUT
Edit Custom Dashboard
DELETE
Delete Custom Dashboard
POST
Create Custom Dashboard Pin
PUT
Update Custom Dashboard Pin
DELETE
Delete Custom Dashboard Pin
POST
Duplicate Custom Dashboard
POST
Set Custom Dashboard Preference
PUT
Share Custom Dashboard
PUT
Remove Share Custom Dashboard