UserPreference

UserPreference
UserPreference

This object represent user-preference.

JSON Example 
{
    "id": "8019c333-1d64-44df-a957-bbb89703ba6a",
    "sequence_number": 349,
    "primary_term": 1,
    "type": "NOTIFICATION_CONSOLE",
    "assign_to": [
        "Operator"
    ],
    "name": "Default notification console",
    "description": "Detailed description about the user-preference",
    "is_predefined": true,
    "is_default": true,
    "parent_id": "string",
    "data": {},
    "created_by": "admin",
    "sub_preferences": [
        {
            "id": "8019c333-1d64-44df-a957-bbb89703ba6a",
            "sequence_number": 349,
            "primary_term": 1,
            "type": "NOTIFICATION_CONSOLE",
            "assign_to": [
                "Operator"
            ],
            "name": "Default notification console",
            "description": "Detailed description about the user-preference",
            "is_predefined": true,
            "is_default": true,
            "parent_id": "string",
            "data": {},
            "created_by": "admin",
            "sub_preferences": [
                "UserPreference Object"
            ],
            "create_timestamp": 1660635421552,
            "update_timestamp": 1660635421552
        }
    ],
    "create_timestamp": 1660635421552,
    "update_timestamp": 1660635421552
}
string
id
Optional

The id, uniquely identified the user-preference.

integer
sequence_number
Optional

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
Optional

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.

string
type
Required

The type user-preference. The below types are supported.

  1. "NOTIFICATION_CONSOLE"
  2. "NOTIFICATION_SUMMARY_CONSOLE"
  3. "TOPOLOGY_CONSOLE"
  4. "COLORS_PREF"
  5. "LOG_VIEWS"
  6. "BAR_CHARTS"
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 assign any ROLE.

string
name
Required

Display name for the console.

string
description
Optional

This is notification console preference, created for admin.

boolean
is_predefined
Optional

system created user preferences.

boolean
is_default
Optional

used to show default user prefereces for user

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.

string
created_by
Optional

The user responsible for creation of object.

array of UserPreference
sub_preferences
Optional

This object represent children of user-preference.

number
create_timestamp
Optional

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

number
update_timestamp
Optional

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

Property Of
Returned By