UserPreferenceConsoleRequest

This object represent user-prefernce create object.

JSON Example

{
    "assign_to": [
        "Operator"
    ],
    "name": "Default notification console",
    "description": "Detailed description about the user-preference",
    "is_predefined": true,
    "is_default": true,
    "parent_id": "string",
    "data": {}
}

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

Set to true only for console which are predefined by system.

boolean

is_default

Optional

Set to true only for default user preferences

string

parent_id

Optional

Parent id of the console. Default value is 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.

Used By

CONSOLE