Get Notification Preferences

Get UserPreferncies categories

Request

URI

GET

https://vmc.vmware.com//api/notification/loggedin/user/preferences/categories

COPY

Query Parameters

string

include

Optional

Denotes if the notification types should be included in the response.
* notification_types - include notification types in the response

string

category_name

Optional

Filter the response and returns only results for the specific category.

Possible values are : Service_Health, Resource_Health, SDDC_Maintenance, Operation, Elastic_DRS, VMware_Site_Recovery_Service, Org_General,

Authentication

This operation uses the following authentication methods.

BearerTokenAuth

Responses

200

Returns NotificationPreferencesResponse of type(s) application/json

{
    "categories": [
        {
            "display_name": "string",
            "name": "string",
            "notification_types": [
                {
                    "display_name": "string",
                    "name": "string",
                    "priority": "string"
                }
            ]
        }
    ]
}

array of NotificationCategoryPreference

categories

Optional

categories

401

Unauthorized

Returns NotificationPreferencesResponse of type(s) application/json

{
    "categories": [
        {
            "display_name": "string",
            "name": "string",
            "notification_types": [
                {
                    "display_name": "string",
                    "name": "string",
                    "priority": "string"
                }
            ]
        }
    ]
}

array of NotificationCategoryPreference

categories

Optional

categories

403

Forbidden

Returns NotificationPreferencesResponse of type(s) application/json

{
    "categories": [
        {
            "display_name": "string",
            "name": "string",
            "notification_types": [
                {
                    "display_name": "string",
                    "name": "string",
                    "priority": "string"
                }
            ]
        }
    ]
}

array of NotificationCategoryPreference

categories

Optional

categories

500

Internal Server Error

Returns ErrorResponse of type(s) application/json

{
    "messages": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "type": "string"
}

ErrorMessage

messages

Optional

messages

string

type

Optional

type

On This Page

Description

Request

Query Parameters