Notifications
Entity - Notifications - handles system notifications
Verb | Request | Notes | Permissions required |
|---|---|---|---|
GET | /Consumer/Notifications | Returns all notifications New for API version 8.0: Only 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.0: Only 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:
Allowed filter columns:
Allowed sort columns:
New for API version 8.0: Only 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 |