Get User Preference By ID
DescriptionThis API is used for fetching the details of requested user-preference.
Request
URLURL
Path Parameters
Path Parameters
Unique id, to indentify the user-preference
Query Parameters
Query Parameters
If set to true, response will also return all other user-preference which is having “id” as “parent_id”. Default is false.
Authentication
Response
Response BodyResponse Body
200 OK
{
"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
}
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.
Timestamp in epoch milliseconds, notifies the value when user preference is created
The user responsible for creation of object.
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.
Display name for the console.
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.
Contains all child preferences. This is optional field and will only be returned when “expand” is set to “true” in request.
The type user-preference. The below types are supported.
- “NOTIFICATION_CONSOLE”
- “NOTIFICATION_SUMMARY_CONSOLE”
- “TOPOLOGY_CONSOLE”
- “COLORS_PREF”
- “LOG_VIEWS”
- “BAR_CHARTS”
Timestamp in epoch milliseconds, notifies the value when user preference is updated
Errors
Unauthorized
Resource not found
Internal server error
