Get Notifications

Get Notifications

Client API to get all notifications

Request
URI
GET
https://vmc.vmware.com//api/notification/{orgId}/notifications
COPY
Path Parameters
string
orgId
Required

Org ID

Query Parameters
string of array
filter
Optional

The name of a property to filter on along with the matching criteria for property values ? =<operation>:<value> Operations : EQ(""), NEQ("ne"), GT("gt"), GTE("gte"), LT("lt"), LTE("lte"), SW("sw"), IN("in"), NOT_IN("not_in"), CONTAINS("contains"), IS("is")
NOTE: you can find more specific description -> https://confluence.eng.vmware.com/display/ATLAS/Domain+API+Patterns#DomainAPIPatterns-Paging,Sorting,andFiltering
Filter Examples:
- ?filter=property_name,operation:value&filter=property_name,operation:value
Property Examples:
- ?type=sw:storage&resource.type=eq:SDDC - returns objects which resource type is equals of SDDC with a type starting with "storage"

integer
size
Optional

The page size, or number of elements returned in a single page. (default is 50) Examples: - /notifications?size=50 - /messages?size=50

integer
page
Optional

The zero-base offset of the result page to return. NOTE: $skip must be used with $top and must be a multiple of $top Examples: - ./notifications?page=2&size=10 - returns the 21st through 30th notification - ./messages?page=2&size=10 - returns the 21st through 30th message

string
sort
Optional

The name of a property to sort on and direction of sorting (asc or desc). NOTE: if multiple sort params are included then sorting will be applied in order of the params. Examples: - ./notifications?sort=type,asc&sort=id,asc - returns notifications sorted in ascending order first by type and the by id - ./messages?sort=type,asc&sort=id,asc - returns messages sorted in ascending order first by type and the by id

boolean
include_count
Optional

Examples: ?include_count=true

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NotificationPageResponse of type(s) application/json 
{
    "content": [
        {
            "callback": {
                "callback_uri": "string"
            },
            "category": "string",
            "client_created_date": "string",
            "client_id": "string",
            "created": "string",
            "created_by": "[email protected]",
            "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
        }
    ],
    "number": 0,
    "number_of_elements": 0,
    "size": 0,
    "total_elements": 0,
    "total_pages": 0
}
array of NotificationResponse
content
Optional

content

integer As int32 As int32
number
Optional

number

integer As int32 As int32
number_of_elements
Optional

number_of_elements

integer As int32 As int32
size
Optional

size

integer As int32 As int32
total_elements
Optional

total_elements

integer As int32 As int32
total_pages
Optional

total_pages


401

Unauthorized

Returns NotificationPageResponse of type(s) application/json 
{
    "content": [
        {
            "callback": {
                "callback_uri": "string"
            },
            "category": "string",
            "client_created_date": "string",
            "client_id": "string",
            "created": "string",
            "created_by": "[email protected]",
            "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
        }
    ],
    "number": 0,
    "number_of_elements": 0,
    "size": 0,
    "total_elements": 0,
    "total_pages": 0
}
array of NotificationResponse
content
Optional

content

integer As int32 As int32
number
Optional

number

integer As int32 As int32
number_of_elements
Optional

number_of_elements

integer As int32 As int32
size
Optional

size

integer As int32 As int32
total_elements
Optional

total_elements

integer As int32 As int32
total_pages
Optional

total_pages


403

Forbidden

Returns NotificationPageResponse of type(s) application/json 
{
    "content": [
        {
            "callback": {
                "callback_uri": "string"
            },
            "category": "string",
            "client_created_date": "string",
            "client_id": "string",
            "created": "string",
            "created_by": "[email protected]",
            "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
        }
    ],
    "number": 0,
    "number_of_elements": 0,
    "size": 0,
    "total_elements": 0,
    "total_pages": 0
}
array of NotificationResponse
content
Optional

content

integer As int32 As int32
number
Optional

number

integer As int32 As int32
number_of_elements
Optional

number_of_elements

integer As int32 As int32
size
Optional

size

integer As int32 As int32
total_elements
Optional

total_elements

integer As int32 As int32
total_pages
Optional

total_pages


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
Notifications Operations
GET
Get Notification
GET
Get Notifications