List available notifications
List available notifications.
Query Parameters
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filters a collection of notifications.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of notifications
Properties of a notification.
Show Child Parameters
Any OfPagination metadata.
Show Child Parameters
Authentication
Query Parameters
Get notification details
Get notification details.
Path Parameters
ID of the notification.
Response
application/json
Response
View a single notification.
Notification
Properties of a notification.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Status of the notification.
Allowed values:READUNREADARCHIVED
Region associated to a notification.
Allowed values:USEUAUMEIN*
Allowed values:plan-and-usageorganizationdev-portalcloud-gatewaysgateway-manager
ID of the entity. Use ‘*’ to represent all entities of this type.
Metadata associated with the notification to build actionable links.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update notification
Update notification.
Path Parameters
ID of the notification.
Body
application/json
Body
Request body schema for updating notification status.
NotificationUpdatePayload
Status of the notification.
Status of the notification.
Allowed values:READUNREADARCHIVED
Response
application/json
Response
View a single notification.
Notification
Properties of a notification.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Status of the notification.
Allowed values:READUNREADARCHIVED
Region associated to a notification.
Allowed values:USEUAUMEIN*
Allowed values:plan-and-usageorganizationdev-portalcloud-gatewaysgateway-manager
ID of the entity. Use ‘*’ to represent all entities of this type.
Metadata associated with the notification to build actionable links.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete notification
Delete notification.
Path Parameters
ID of the notification.
Response
Response
No Content
Authentication
Path Parameters
Mark a list of notifications to a status
Mark a list of notifications to a status.
Body
application/json
Body
Request body schema for bulk status update.
BulkPayload
Request body schema for bulk status update.
>= 1 items<= 100 items
Status of the notification.
Allowed values:READUNREADARCHIVED
Response
Response
No Content