Entity - Notifications - handles system notifications

Page version: 7, last updated:



VerbRequestNotesPermissions required
GET/Consumer/Notifications

Returns all notifications

New for API version 8.0Only returns notifications where the InstructionId column is either NULL or refers to an instruction that is authorised for the invoking user in accordance with the rules for instruction visibility based on Management Groups (see the Instructions page).

'Read' permission to security
GET/Consumer/Notifications/{instructionId}

Returns all notifications for a specific instruction

New for API version 8.0: The list of notifications will come back empty if the selected instruction is not accessible to the user in accordance with the rules for instruction visibility based on Management Groups (see above).

'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)

New for API version 8.0Only returns notifications where the InstructionId column is either NULL or refers to an instruction that is authorised for the invoking user in accordance with the rules for instruction visibility based on Management Groups (see the Instructions page).

'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

New for API version 8.0Only returns notifications where the InstructionId column is either NULL or refers to an instruction that is authorised for the invoking user in accordance with the rules for instruction visibility based on Management Groups (see the Instructions page).

'Read' permission to security