UserPreferenceUpdateRequest

UserPreferenceUpdateRequest

This object represent user-preference.

JSON Example

{
    "id": "1jldkjdfjrr",
    "name": "Default notification console",
    "type": "NOTIFICATION_CONSOLE",
    "assign_to": [
        "Operator"
    ],
    "is_default": true,
    "parent_id": "string",
    "data": {},
    "sequence_number": 349,
    "primary_term": 1,
    "create_timestamp": 1660635421552
}

string

id

Optional

unique id for the user preference.

string

name

Required

Display name for the user preference.

string

type

Required

The type user-preference. There are 4 types supported.

1. "NOTIFICATION_CONSOLE"
2. "NOTIFICATION_SUMMARY_CONSOLE"
3. "TOPOLOGY_CONSOLE"
4. "COLORS_PREF"

array of string

assign_to

Optional

The console is assigned to which ROLE. For logged in user , this field value will be populated automatically, but if Admin user wants to assign, the console to any ROLE then it needs to be sent in the request payload. Non admin user won't be able to assign any ROLE.

boolean

is_default

Optional

This defines wheather the "user-preference" is default.

string

parent_id

Optional

Parent id of the console. In case of the root, value would be null.

object

data

Optional

This will contain all UI specific user-preference details. This is free object and can contain any thing UI wants to store.

integer

sequence_number

Required

The seq_no and primary_term together, helps to achieve optimized concurrency control. This two field value, must be sent along with update request, if user want to avoid accidental concurrent changes.

integer

primary_term

Required

The seq_no and primary_term together, helps to achieve optimized concurrency control. This two field value, must be sent along with update request, if user want to avoid accidental concurrent changes.

number

create_timestamp

Optional

Timestamp in epoch milliseconds, notifies the value when user preference is created

Parameter To

Update User Preference