Get Notifications
Client API to get all notifications
Org ID
The name of a property to filter on along with the matching criteria for property values ?
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"
The page size, or number of elements returned in a single page. (default is 50) Examples: - /notifications?size=50 - /messages?size=50
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
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
Examples: ?include_count=true
OK
{
"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
}number
number_of_elements
size
total_elements
total_pages
Unauthorized
{
"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
}number
number_of_elements
size
total_elements
total_pages
Forbidden
{
"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
}number
number_of_elements
size
total_elements
total_pages
Internal Server Error
{
"messages": {
"args": [
"string"
],
"default_message": "string",
"id": "string"
},
"type": "string"
}type