Get Notification

Client API to get notification by Id

Request

URI

GET

https://vmc.vmware.com//api/notification/{orgId}/notifications/{id}

COPY

Path Parameters

string

orgId

Required

Org ID

string

Required

Notification ID

Authentication

This operation uses the following authentication methods.

BearerTokenAuth

Responses

200

Returns NotificationResponse of type(s) application/json

{
    "callback": {
        "callback_uri": "string"
    },
    "category": "string",
    "client_created_date": "string",
    "client_id": "string",
    "created": "string",
    "created_by": "test@vmware.com",
    "deployment": "string",
    "description": "string",
    "error_message": "string",
    "expiry_date": "string",
    "id": "string",
    "initiated_by": "string",
    "name": "string",
    "notification_type": "string",
    "omnichannels": [
        {
            "allowed_roles": [
                "string"
            ],
            "email_preferences": {
                "bcc": [
                    "string"
                ],
                "cc": [
                    "string"
                ],
                "operation": "string",
                "recipients": [
                    {
                        "email": "string",
                        "locale": "string"
                    }
                ]
            },
            "name": "string",
            "operation": "string",
            "visual_components": [
                "string"
            ]
        }
    ],
    "org_id": "string",
    "priority": "string",
    "provider": "string",
    "resource_id": "string",
    "resource_name": "string",
    "resource_type": "string",
    "status": "string",
    "translated": false,
    "translation_id": "string",
    "updated": "string",
    "user_name": "string",
    "version": 0
}

CallBackModel

callback

Optional

callback

string

category

Optional

The category of the notification.

string As date-time As date-time

client_created_date

Optional

Timestamp when the event that triggers the notification was created

string As uuid As uuid

client_id

Required

The client Id. For example, Operation Service will send Operation Id

string As date-time As date-time

created

Optional

The creation date of entity.

string

created_by

Optional

The username of the person/app who created the notification

string

deployment

Optional

The deployment type - AWS, Dimension, and Outpost

string

description

Optional

Human-readable long representation of notification type.

string

error_message

Optional

Error message provided by client services.

string As date-time As date-time

expiry_date

Optional

Timestamp when the notification will expire(valid only for VMCUI channel)

string As uuid As uuid

Optional

The id of notification.

string

initiated_by

Optional

initiated_by

string

name

Optional

Human-readable short representation of notification type.

string

notification_type

Required

The type of notification.

array of NotificationChannel

omnichannels

Optional

Channel

string As uuid As uuid

org_id

Required

The org id of the notification.

object

payload

Optional

External payload of notification.

string

priority

Optional

The priority of notification. Allowed values - Critical, Warning, Information, Error, Success or their translations for the supported locales

string

provider

Optional

The deployment type - AWS, Dimension, and Outpost

string As uuid As uuid

resource_id

Required

The Id of resource that generated the notification.

string

resource_name

Optional

Human-readable name of the resource.

string

resource_type

Required

resource_type

Possible values are : SDDC, ORG, VM, NAMESPACE,

string

status

Optional

status

Possible values are : RECEIVED, SENDING, PROCESSING_FAILED, SENT, FAILED, CANCELED, PARTIAL_SENT, SCHEDULED,

boolean

translated

Optional

translated

string As uuid As uuid

translation_id

Optional

translation_id

string As date-time As date-time

updated

Optional

The update date of entity.

string

user_name

Optional

user_name

integer As int32 As int32

version

Optional

Version of this entity.

401

Unauthorized

Returns NotificationResponse of type(s) application/json

{
    "callback": {
        "callback_uri": "string"
    },
    "category": "string",
    "client_created_date": "string",
    "client_id": "string",
    "created": "string",
    "created_by": "test@vmware.com",
    "deployment": "string",
    "description": "string",
    "error_message": "string",
    "expiry_date": "string",
    "id": "string",
    "initiated_by": "string",
    "name": "string",
    "notification_type": "string",
    "omnichannels": [
        {
            "allowed_roles": [
                "string"
            ],
            "email_preferences": {
                "bcc": [
                    "string"
                ],
                "cc": [
                    "string"
                ],
                "operation": "string",
                "recipients": [
                    {
                        "email": "string",
                        "locale": "string"
                    }
                ]
            },
            "name": "string",
            "operation": "string",
            "visual_components": [
                "string"
            ]
        }
    ],
    "org_id": "string",
    "priority": "string",
    "provider": "string",
    "resource_id": "string",
    "resource_name": "string",
    "resource_type": "string",
    "status": "string",
    "translated": false,
    "translation_id": "string",
    "updated": "string",
    "user_name": "string",
    "version": 0
}

CallBackModel

callback

Optional

callback

string

category

Optional

The category of the notification.

string As date-time As date-time

client_created_date

Optional

Timestamp when the event that triggers the notification was created

string As uuid As uuid

client_id

Required

The client Id. For example, Operation Service will send Operation Id

string As date-time As date-time

created

Optional

The creation date of entity.

string

created_by

Optional

The username of the person/app who created the notification

string

deployment

Optional

The deployment type - AWS, Dimension, and Outpost

string

description

Optional

Human-readable long representation of notification type.

string

error_message

Optional

Error message provided by client services.

string As date-time As date-time

expiry_date

Optional

Timestamp when the notification will expire(valid only for VMCUI channel)

string As uuid As uuid

Optional

The id of notification.

string

initiated_by

Optional

initiated_by

string

name

Optional

Human-readable short representation of notification type.

string

notification_type

Required

The type of notification.

array of NotificationChannel

omnichannels

Optional

Channel

string As uuid As uuid

org_id

Required

The org id of the notification.

object

payload

Optional

External payload of notification.

string

priority

Optional

The priority of notification. Allowed values - Critical, Warning, Information, Error, Success or their translations for the supported locales

string

provider

Optional

The deployment type - AWS, Dimension, and Outpost

string As uuid As uuid

resource_id

Required

The Id of resource that generated the notification.

string

resource_name

Optional

Human-readable name of the resource.

string

resource_type

Required

resource_type

Possible values are : SDDC, ORG, VM, NAMESPACE,

string

status

Optional

status

Possible values are : RECEIVED, SENDING, PROCESSING_FAILED, SENT, FAILED, CANCELED, PARTIAL_SENT, SCHEDULED,

boolean

translated

Optional

translated

string As uuid As uuid

translation_id

Optional

translation_id

string As date-time As date-time

updated

Optional

The update date of entity.

string

user_name

Optional

user_name

integer As int32 As int32

version

Optional

Version of this entity.

403

Forbidden

Returns NotificationResponse of type(s) application/json

{
    "callback": {
        "callback_uri": "string"
    },
    "category": "string",
    "client_created_date": "string",
    "client_id": "string",
    "created": "string",
    "created_by": "test@vmware.com",
    "deployment": "string",
    "description": "string",
    "error_message": "string",
    "expiry_date": "string",
    "id": "string",
    "initiated_by": "string",
    "name": "string",
    "notification_type": "string",
    "omnichannels": [
        {
            "allowed_roles": [
                "string"
            ],
            "email_preferences": {
                "bcc": [
                    "string"
                ],
                "cc": [
                    "string"
                ],
                "operation": "string",
                "recipients": [
                    {
                        "email": "string",
                        "locale": "string"
                    }
                ]
            },
            "name": "string",
            "operation": "string",
            "visual_components": [
                "string"
            ]
        }
    ],
    "org_id": "string",
    "priority": "string",
    "provider": "string",
    "resource_id": "string",
    "resource_name": "string",
    "resource_type": "string",
    "status": "string",
    "translated": false,
    "translation_id": "string",
    "updated": "string",
    "user_name": "string",
    "version": 0
}

CallBackModel

callback

Optional

callback

string

category

Optional

The category of the notification.

string As date-time As date-time

client_created_date

Optional

Timestamp when the event that triggers the notification was created

string As uuid As uuid

client_id

Required

The client Id. For example, Operation Service will send Operation Id

string As date-time As date-time

created

Optional

The creation date of entity.

string

created_by

Optional

The username of the person/app who created the notification

string

deployment

Optional

The deployment type - AWS, Dimension, and Outpost

string

description

Optional

Human-readable long representation of notification type.

string

error_message

Optional

Error message provided by client services.

string As date-time As date-time

expiry_date

Optional

Timestamp when the notification will expire(valid only for VMCUI channel)

string As uuid As uuid

Optional

The id of notification.

string

initiated_by

Optional

initiated_by

string

name

Optional

Human-readable short representation of notification type.

string

notification_type

Required

The type of notification.

array of NotificationChannel

omnichannels

Optional

Channel

string As uuid As uuid

org_id

Required

The org id of the notification.

object

payload

Optional

External payload of notification.

string

priority

Optional

The priority of notification. Allowed values - Critical, Warning, Information, Error, Success or their translations for the supported locales

string

provider

Optional

The deployment type - AWS, Dimension, and Outpost

string As uuid As uuid

resource_id

Required

The Id of resource that generated the notification.

string

resource_name

Optional

Human-readable name of the resource.

string

resource_type

Required

resource_type

Possible values are : SDDC, ORG, VM, NAMESPACE,

string

status

Optional

status

Possible values are : RECEIVED, SENDING, PROCESSING_FAILED, SENT, FAILED, CANCELED, PARTIAL_SENT, SCHEDULED,

boolean

translated

Optional

translated

string As uuid As uuid

translation_id

Optional

translation_id

string As date-time As date-time

updated

Optional

The update date of entity.

string

user_name

Optional

user_name

integer As int32 As int32

version

Optional

Version of this entity.

404

Not Found

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

500

Server Internal 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

Path Parameters