notification

Notification Search

Changed on

Search this users Notifications

get/notification

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/notification
  • Auth
    none declared

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

  • 622fb073aecdRevision changes
    • info

      added the optional property /// to the response with the status

  • fe497e811c7fRevision changes
    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status