Get User Preference By Id
This API is used for fetching the details of requested user-preference.
Unique id, to indentify the user-preference
If set to true, response will also return all other user-preference which is having "id" as "parent_id". Default is false.
Ok
{
"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",
"create_timestamp": 1660635421552,
"update_timestamp": 1660635421552,
"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
}
]
}The id, uniquely identified the user-preference.
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.
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.
Display name for the console.
This is notification console preference, created for admin.
system created user preferences.
used to show default user prefereces for user
Parent id of the console. In case of the root, value would be null.
This will contain all UI specific user-preference details. This is free object and can contain any thing UI wants to store.
The user responsible for creation of object.
Timestamp in epoch milliseconds, notifies the value when user preference is created
Timestamp in epoch milliseconds, notifies the value when user preference is updated
Contains all child preferences. This is optional field and will only be returned when "expand" is set to true in request.
Unauthorized
Resource not found
Internal server error
curl -H 'Authorization: <value>' https://{api_host}/tcsa/api/configuration-management/v1/user-preferences/{id}