notification

Notification Search

Search this users Notifications

get/notification

Query parameters

notificationIdinteger

Filter by Notification Id

subjectstring

Filter by Subject

embedstring

Embed related data such as userGroups,displayGroups

sortBy'subject' | 'type' | 'releaseDt' | 'isInterrupt'

Column to sort by. Used together with sortDir.

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

notificationIdinteger

The Notifcation ID

createDtinteger

Create Date as Unix Timestamp

releaseDtinteger

Release Date as Unix Timestamp

subjectstring

The subject line

typestring

The Notification type

bodystring

The HTML body of the notification

isInterruptinteger

Should the notification interrupt the CMS UI on navigate/login

isSysteminteger

Flag for system notification

userIdinteger

The Owner User Id

filenamestring

Attachment filename

originalFileNamestring

Attachment originalFileName

nonusersstring

Additional email addresses to which a saved report will be sent

canEditboolean

Flag indicating whether the current user can edit this notification

canDeleteboolean

Flag indicating whether the current user can delete this notification

Changes

Changed in 3 of the 52 revisions of this API.15

    • added the new optional query request parameter sortBy

      new-optional-request-parameter

    • added the new optional query request parameter sortDir

      new-optional-request-parameter

    • added the optional property items/canDelete to the response with the 200 status

      response-optional-property-added

    • added the optional property items/canEdit to the response with the 200 status

      response-optional-property-added

    • added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the media type application/json for the response with the status 200

      response-media-type-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog