Notification - Post User Notification
Post user notifications to the Notification service. This API is deprecated.
For a list of region-specific service URLs, see Service URL
POST {ServiceUrl}/api/v1.2/NotificationsRequest Body
Media Types: "application/json", "text/json"
| Name | Type | Description |
|---|---|---|
| AdminId |
string |
ID of the admin associated with the notification |
| Content |
The content associated with the notification. |
|
| CreatedAt |
string |
The date and time of when the notification was created. |
| Environments |
The environments associated with the notification. |
|
| NotificationId |
string |
ID of the current notification |
| OrgId |
string |
The id of the org associated with the notification. |
| Priority |
The priority of the notification. |
|
| State |
The state of the notification |
|
| TenantId |
string |
ID of the tenant associated with the notification |
Responses
| Name | Type | Description |
|---|---|---|
| 202 Accepted |
PostUserNotification Operation Started Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
There was an issue either validating or starting the PostUserNotification operation. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
NotFound Media Types: "application/json", "text/json" |
Definitions
| Name | Description |
|---|---|
|
Environment |
A representation of an environment metadata of an user notification. |
|
Item |
Set of values to define an error or information item |
|
Notification |
A representation of the content associated with a notification. |
|
Notification |
The priority of the notification. |
|
Notification |
The state of the notification |
|
Operation |
The operation context object |
|
Operation |
State of the operation |
|
Operation |
Status of the operation |
|
User |
A representation of a notification that has been retrieved from or already exists in the Notification Service |
EnvironmentMetadata
A representation of an environment metadata of an user notification.
| Name | Type | Description |
|---|---|---|
| Geo |
string |
Geographic location of the environment metadata |
| Id |
string |
ID of the environment metadata |
| Name |
string |
Name of the environment metadata |
ItemDescription
Set of values to define an error or information item
| Name | Type | Description |
|---|---|---|
| Code |
string |
Code of the item |
| Description |
string |
Description of the item |
| Subject |
string |
Subject of the item |
NotificationContent
A representation of the content associated with a notification.
| Name | Type | Description |
|---|---|---|
| Slugs |
object |
The slugs to be populated into the NotificationContent. |
| TemplateId |
string |
The id of the template associated with this NotificationContent. |
| TemplateType |
string |
The type of the template associated with this NotificationContent. |
NotificationPriority
The priority of the notification.
| Value | Description |
|---|---|
| High | |
| Low | |
| Unknown |
NotificationState
The state of the notification
| Value | Description |
|---|---|
| Disabled | |
| FailedProvisioning | |
| Inactive | |
| Locked | |
| None | |
| Pending | |
| Read | |
| Ready | |
| ReadyToConfigure | |
| Unread |
OperationContext
The operation context object
| Name | Type | Description |
|---|---|---|
| Items |
object |
The item object |
OperationState
State of the operation
| Value | Description |
|---|---|
| Aborted | |
| Aborting | |
| Cancelled | |
| Cancelling | |
| Conflict | |
| Deleted | |
| Deleting | |
| Failed | |
| FailedToCreate | |
| None | |
| NotFound | |
| NotStarted | |
| Pending | |
| Ready | |
| Running | |
| Succeeded | |
| Tombstone |
OperationStatus
Status of the operation
| Name | Type | Description |
|---|---|---|
| Context |
The operation context object |
|
| Errors |
Set of values to display errors during an operation |
|
| Information |
Set of values to display information during an operation |
|
| OperationId |
string |
ID of the operation |
| OperationLocation |
string |
Location of the operation |
| ResourceLocation |
string |
Location of the resource |
| Status |
State of the operation |
UserNotification
A representation of a notification that has been retrieved from or already exists in the Notification Service
| Name | Type | Description |
|---|---|---|
| AdminId |
string |
ID of the admin associated with the notification |
| Content |
The content associated with the notification. |
|
| CreatedAt |
string |
The date and time of when the notification was created. |
| Environments |
The environments associated with the notification. |
|
| NotificationId |
string |
ID of the current notification |
| OrgId |
string |
The id of the org associated with the notification. |
| Priority |
The priority of the notification. |
|
| State |
The state of the notification |
|
| TenantId |
string |
ID of the tenant associated with the notification |