Get User Defined Event

Get User Defined Event

Get details of an existing User defined event.

Request
URI
GET
https://www.mgmt.cloud.vmware.com/ni/api/ni/settings/events/user-defined-events/{id}
COPY
Path Parameters
string
id
Required

entity id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SubscriptionResponse of type(s) application/json 
{
    "entity_id": "string",
    "active": "boolean",
    "event_name": "string",
    "is_problem": "boolean",
    "severity": "string",
    "search_criteria": "string",
    "generate_event_criteria": "string",
    "email_frequency": "string",
    "daily_at_utc": "string",
    "email_ids": [
        "string"
    ],
    "snmp_trap_entity_ids": [
        "string"
    ]
}
string
entity_id
Optional

entity_id

boolean
active
Optional

active

string
event_name
Optional

event_name

boolean
is_problem
Optional

is_problem

Severity
severity
Optional

severity

string
search_criteria
Optional

search_criteria

GenerateEventCritera
generate_event_criteria
Optional

generate_event_criteria

EmailFrequency
email_frequency
Optional

email_frequency

string
daily_at_utc
Optional

daily_at_utc

array of string
email_ids
Optional

email_ids

array of string
snmp_trap_entity_ids
Optional

snmp_trap_entity_ids


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


404

Not Found

Returns ApiError of type(s) application/json 
{
    "code": "integer",
    "message": "string",
    "details": [
        {
            "code": "integer",
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


500

Internal Error

Operation doesn't return any data structure

On This Page
Settings Operations
POST
Add new SNMP destination profile
DELETE
Delete An existing SNMP destination profile
GET
Get details Of An existing SNMP destination profile
GET
List the configured SNMP destination profiles
POST
Migrate event subscriptions To other SNMP destination profiles
POST
Send Test trap To SNMP destination profile
PUT
Update An existing SNMP destination profile
PUT
Update user password
POST
Add Backup Config
POST
Add Ip Tag
POST
Add Restore Config
POST
Create Subnet Mapping
POST
Create User Defined Event
DELETE
Delete Backup Config
DELETE
Delete Restore Config
DELETE
Delete Subnet Mapping
DELETE
Delete User Defined Event
POST
Disable Backup
POST
Disable User Defined Event
POST
Enable Backup
POST
Enable User Defined Event
GET
Get All User Defined Events
GET
Get Backup Config
GET
Get Backup Status Report
GET
Get Ip Tag
GET
Get Ip Tag Ids
GET
Get Restore Config
GET
Get Restore Status Report
GET
Get Subnet Mappings
GET
Get User Defined Event
POST
Remove Ip Tag
PUT
Update Backup Config
PUT
Update Subnet Mapping
PUT
Update User Defined Event