Contents

Notifications

Entity - Notifications - handles system notifications

Page version: 6, last updated:



VerbRequestNotesPermissions required
GET/Consumer/NotificationsReturns all notifications'Read' permission to security
GET/Consumer/Notifications/{instructionId}Returns all notifications for a specific instruction'Read' permission to security
GET/Consumer/Notifications/Component/{component}/{componentId:int?}Returns all notifications for a specific component of the system or specific component type (so for instance for specific Switch or all Switches)'Read' permission to security
POST/Consumer/Notifications

Returns notifications that fulfil conditions specified in the request body:

  • filter - filter expression.To learn about how to define filter check Using scope and filter expressions page.
  • sort - sort expression. To learn about how to define sort criteria check Sort Definition page.
  • start - starting index to support pagination. It begins from 1.
  • pagesize - number of results to fetch

Allowed filter columns:

  • Component
  • ComponentId
  • CreatedTime
  • Message
  • Operation
  • InstructionId
  • Type

Allowed sort columns:

  • Component
  • ComponentId
  • Message
  • CreatedTime
  • Operation
  • InstructionId
'Read' permission to security