Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Notifications

Get a notification

Retrieves a specified notification.

get/notifications/{id}

Path parameters

idstring required

Response

When request is successful. Returns a 'Notification' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the notification.

createdByUserIdstring nullable

The user that created this notification.

createdDatestring nullable

Staff id to notify.

iconstring nullable

The icon to display for the notification.

iconColorstring nullable

The icon hex color to display for the notification.

messagestring nullable

The message to display for the notification.

toastyIconstring nullable

The icon to display for the toast notification.

toastyMessagestring nullable

The message to display for the message.

isReadboolean

True if the notification has been forcefully read by the user.

This is different to the <seealso cref="P:ItOps.NotificationCentre.Api.Resources.Notification.HasBeenSeen" /> property - which is not forceful.

hasBeenSeenboolean

True if the notification was "seen" by the user.

This is different to the forceful "read" state.

creationTimestampstring date-time

The time the notification was created.

updatedDatestring date-time

The last time the notification was modified (marked as read, deleted etc).

isDeletedboolean

True if the notification has been deleted.

Example response

{
  "id": "e2fd015b-8a60-42be-9ea4-b2ef7aa0289b",
  "createdByUserId": "db0b4298-67ef-4638-a92a-5bb830ea6af6",
  "createdDate": "\"832e778f-83df-454a-b344-768a862a7e67\"",
  "iconColor": "#25C9A4",
  "message": "[@staffId] has **assigned** you a Task.",
  "updatedDate": "2020-02-15T00:00:00Z"
}