Get User Preferences By Query

This 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

URI

GET

https://{api_host}/tcsa.host.com/tcsa/api/configuration-management/v1/user-preferences

COPY

Query Parameters

string

type

Optional

The type user-preference. can query multiple types by comma (,) separted string

string

parent_id

Optional

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.

string

include

Optional

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.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns Array of UserPreference of type(s) application/json

[
    {
        "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
    }
]

401

Unauthorized

Operation doesn't return any data structure

404

Resource not found

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

On This Page

Description

Request