Get User Preferences By Query
DescriptionThis API is used for getting user-preferences based on query parameters. If no query parameter is passed then, API will return all available user-preferences for requested user.
Request
URLURL
Query Parameters
Query Parameters
This will contain comma seperated string values. If the “include” field is passed, the result will contain only the requested field name. The “id” and “name” will be return always irrespective of include fields.
Id of the parent user-preference. When parent_id is used as query filter, the API will return all user-preference for which the parent_id matches.
The type user-preference. can query multiple types by comma (,) separted string
Authentication
Response
Response BodyResponse Body
200 OK
array of
UserPreference
of type application/json
{
"create_timestamp": 1660635421552,
"created_by": "admin",
"description": "Detailed description about the user-preference",
"id": "8019c333-1d64-44df-a957-bbb89703ba6a",
"is_default": true,
"is_predefined": true,
"name": "Default notification console",
"parent_id": "",
"primary_term": 1,
"sequence_number": 349,
"type": "NOTIFICATION_CONSOLE",
"update_timestamp": 1660635421552
}
Display name for the console.
The type user-preference. The below types are supported.
- “NOTIFICATION_CONSOLE”
- “NOTIFICATION_SUMMARY_CONSOLE”
- “TOPOLOGY_CONSOLE”
- “COLORS_PREF”
- “LOG_VIEWS”
- “BAR_CHARTS”
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.
This will contain all UI specific user-preference details. This is free object and can contain any thing UI wants to store.
This is notification console preference, created for admin.
The id, uniquely identified the user-preference.
used to show default user prefereces for user
system created user preferences.
The user responsible for creation of object.
Parent id of the console. In case of the root, value would be null.
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.
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.
Timestamp in epoch milliseconds, notifies the value when user preference is created
Timestamp in epoch milliseconds, notifies the value when user preference is updated
Errors
Unauthorized
Resource not found
Internal server error
