[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

UserPreference

This object represent user-preference.


Properties

string
name Required

Display name for the console.


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.


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
description Optional

This is notification console preference, created for admin.


string
id Optional

The id, uniquely identified the user-preference.


boolean
is_default Optional

used to show default user prefereces for user


boolean
is_predefined Optional

system created user preferences.


string
created_by Optional

The user responsible for creation of object.


string
parent_id Optional

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


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.


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.


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

JSON Example

{
    "name": "Default notification console",
    "type": "NOTIFICATION_CONSOLE"
}
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Property Of

UserPreference
UserPreferenceExpandedResponse
Returned By

Get User Preferences By Query
Update User Preference

Feedback

Was this page helpful?