GET /events/notifications

Use this method to return configuration and subscription information for all push notification services.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/events/notifications

Query parameters

Parameters	Required / Optional	Type	Definition
personalDataOnly=`{Boolean}`	Optional	Boolean	Indicates whether to return only subscriptions that were created by the user that is logged on. This can be one of the following values. true. Returns only subscriptions that the user created. false. Returns all subscriptions. This is the default value.
pusher=`{type}`	Optional	String	Returns information for a specific push notification service. This can be one of the following values. AndroidPusher. Google device push service iOSPusher. Apple device push service WebSocketPusher. WebSocket servic
details=`{Boolean}`	Optional	Boolean	Indicates whether to include detailed information about each service type (pusher). This can be one of the following values. true. Returns detailed information about each device type. false. Returns only a list of device types. This is the default value.

The following example returns detailed configuration and subscription information for all push notification services that were created by the user that is logged on.

GET https://192.0.2.0/events/notifications?personalDataOnly=true&details=true

The following example returns detailed configuration and subscription information for all Google device push services that were created by the user that is logged on.

GET https://192.0.2.0/events/notifications?pusher=AndroidPusher&details=true

Request body

None

Response codes

Code	Description	Comments
200	OK	The request completed successfully.
400	Bad Request	A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401	Unauthorized	The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500	Internal Server Error	An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes						Type	Definition
connectionIdle						Integer	(WebSocket push services only) Maximum amount of inactivity, in seconds. After this period the connection ends.
descriptionStr						String	Description of the push notification service
enable						Boolean	Indicates whether the push notification is enabled
maxBufferSize						Integer	(WebSocket push services only) Maximum size of a message, in KB
maxSubscribers						Integer	(WebSocket push services only) Maximum number of subscriptions
name						String	Name of the push notification service
nameStr						String	Displayable name of the push notification service
registerTimeout						Integer	(WebSocket push services only) Registration time-out, in seconds This is the number of seconds that the subscription has to sent a valid configuration JSON after the connection is initiated. If the JSON configuration is not sent within the time period, the connection ends.
subscriptions						Array of objects	List of subscriptions
	filterList					Array of objects	Information about predefined and custom event filters
		eventFilter				Array of objects	Information about the types of events to filter
			filter			Object	Information about each event filter
				categories		Array of strings	Event categories. This can be one of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
				componentIDs		Array of strings	List of component IDs, separated by a comma, that the event filter accepts in an event. If empty, all components are accepted.
				sourceIDs		Array of strings	List of source IDs. If empty, all sources are accepted.
				typeSeverity		Array of objects	Event severity and type If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
					severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
					type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
		eventFilterDescription				String	Event filter description
		eventFilterName				String	Event filter name
		isDeletable				Boolean	Indicates whether the event filter can be deleted.
		isEditable				Boolean	Indicates whether this event filter can be modified
		isUsed				Boolean	Indicates whether this event filter is used by at least one subscription
		lockedPredefinedFilter				Boolean	Indicates whether this is a predefined event filter that is provided by default by XClarity Administrator
		matchEveryCoreEvent				Boolean	Indicates whether this event filter accepts all core events
		matchEverySystem				Boolean	Indicates whether this event filter must match every event from every managed device
		matchEverything				Boolean	Indicates whether this event filter matches all events
		name				String	User-defined name of the event filter. This must be unique for all filters.
	ipAddress					String	(WebSocket push services only) IP address
	lastPushStatus					String	Status of the last push attempt
	lastPushEventID					String	ID of the last pushed event
	lastPushTimeStamp					String	Date of the last push attempt
	phoneUID					String	(Android and iOS push services only) The displayable phone ID
	registrationID					String	(Android and iOS push services only) The unique registration ID for a mobile device. You can find the push registration ID from the Lenovo XClarity Mobile app by tapping Settings > About > Push registration ID.
	subscriberCategory					String	Subscription category
	subscriberCategoryExplanation					String	Description of the subscription category
	uid					String	Subscription UID
	userName					String	User that created the subscription

The following example is returned if the request is successful and when no query parameters are specified.

[{
   "descriptionStr": "The Google device push service",
   "enable": true,
   "name": "AndroidPusher",
   "nameStr": "Android Service"
},
{
   "descriptionStr": "The Apple device push service",
   "enable": true,
   "name": "iOSPusher",
   "nameStr": "iOS Service"
},
{
   "descriptionStr": "The XClarity WebSockets push service",
   "enable": true,
   "name": "WebSocketPusher",
   "nameStr": "WebSocket Service"
}]

The following example is returned if the request is successful and detailed information about the push notification services that were created by the user that is logged on.

{
   "enable": true,
   "descriptionStr": "The Apple device push service",
   "name": "iOSPusher",
   "nameStr": "iOS Service",
   "subscriptions": [{
      "filterList": [{
         "eventFilter": {
            "filter": {
               "typeSeverity": [{
                  "severity": "MAJOR",
                  "type": "UNKNOWN"
               },
               ...,
               {
                  "severity": "FATAL",
                  "type": "SWITCH"
               }],
               "sourceIDs": [],
               "categories": ["GENERAL"],
               "componentIDs": []
            }
         },
         "eventFilterDescription": "This filter will match all critical event generated in any
                                   of the managed endpoints or the manage server itself.",
         "eventFilterName": "Match All Critical",
         "isDeletable": false,
         "isEditable": false,
         "isUsed": true,
         "lockedPredefinedFilter": true,
         "matchEveryCoreEvent": false,
         "matchEverySystem": true,
         "matchEverything": false
      },
      {
         "eventFilter": {
            "filter": {
               "typeSeverity": [{
                  "severity": "WARNING",
                  "type": "UNKNOWN"
               },
               ...,
               {
                  "severity": "MINOR",
                  "type": "SWITCH"
               }],
               "sourceIDs": [],
               "categories": ["GENERAL"],
               "componentIDs": []
            }
         },
         "eventFilterDescription": "This filter will match all warning event generated in any
                                   of the managed endpoints or the manage server itself.",
         "eventFilterName": "Match All Warning",
         "isEditable": false,
         "isDeletable": false,
         "isUsed": true,
         "lockedPredefinedFilter": true,
         "matchEveryCoreEvent": false,
         "matchEverySystem": true,
         "matchEverything": false
      }],
      "subscriberCategoryExplanation": "This is a Apple Phone Subscriber",
      "lastPushEventID": "FQXHMEM0405I",
      "lastPushStatus": "Failure : java.net.SocketTimeoutException: Read timed out",
      "lastPushTimeStamp": "2017-03-29T15:16:30Z",
      "phoneUID": "5d57a0 ... 17b656",
      "registrationID": "5d57a05de25b7b91344931a91a64f0157bcaa834c8e6afe758e3f93da317b656",
      "subscriberCategory": "iOS Subscriber",
      "uid": "2",
      "userName": "USERID"
   }]
}

Give documentation feedback

GET /events/notifications

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​