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.

ApiKeyAuth

Responses

200

Success

Operation doesn't return any data structure

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

500

Internal Error

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details