Skip to main content

GET /events/notifications/{pusher_type}/subscriptions/{subscription_ID}

Use this method to return information about a specific subscription for a specific push notification service.

If you are logged in as a user with one of the following roles, information is associated with all subscriptions is returned; otherwise, information associated with subscriptions for only the logged-in user is returned.
  • lxc-admin
  • lxc-supervisor
  • lxc-security-admin
  • lxc-sysmgr

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/events/notifications/{pusher_type}/subscriptions/{subscription_ID}
where
  • {pusher_type} is the type of push notification service. This can be one of the following values.

    • AndroidPusher. Google device push service
    • iOSPusher. Apple device push service
    • WebSocketPusher. WebSocket servic
    Tip
    Because the subscription ID is unique, specifying the type of push notification service is optional
  • {subscription_ID} is the UID of the subscription to be retrieved. To obtain the subscription UID, use the GET /events/notifications/subscriptions method.

Query parameters

None

Request body

None

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

AttributesTypeDefinition
filterListArray of objectsList of predefined and custom event filters
 eventFilterArray of objectsInformation about the types of events to filter
  filterObjectInformation about each event filter
   categoriesArray of stringsEvent 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.
   componentIDsArray of stringsList of component IDs. If empty, all components are accepted.
   sourceIDsArray of stringsList of source IDs. If empty, all sources are accepted.
   typeSeverityArray of objectsEvent severity and type.

If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter is forwarded.

    severityStringEvent 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.
    typeStringEvent 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. switch
 eventFilterDescriptionStringEvent filter description
 eventFilterNameStringEvent filter name
 isDeletableBooleanIndicates whether the event filter can be deleted.
 isEditableBooleanIndicates whether this event filter can be modified
 isUsedBooleanIndicates whether this event filter is used by at least one subscription
 lockedPredefinedFilterBooleanIndicates whether this is a predefined event filter that is provided by default by XClarity Administrator
 matchEveryCoreEventBooleanIndicates whether this event filter accepts all core events
 matchEverySystemBooleanIndicates whether this event filter must match every event from every managed device
 matchEverythingBooleanIndicates whether this event filter matches all events
 matchEverythingBooleanIndicates whether this event filter matches all events
 nameStringUser-defined name of the event filter. This must be unique for all filters.
lastPushStatusStringStatus of the last push attempt
lastPushEventIDStringID of the last pushed event
lastPushTimeStampStringDate of the last push attempt
phoneUIDString(Android and iOS push services only) The displayable phone ID
registrationIDString(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
subscriberCategoryStringSubscription category
subscriberCategoryExplanationStringDescription of the subscription category
uidStringSubscription UID
userNameStringUser that created the subscription
The following example is returned if the request is successful.
[{
"filterList": [{
"eventFilter": {
"filter": {
"categories": ["GENERAL"],
"componentIDs": [],
"sourceIDs": [],
"typeSeverity": [{
"severity": "MAJOR",
"type": "UNKNOWN"
},
...,
{
"severity": "FATAL",
"type": "SWITCH"
}]
}
},
"eventFilterDescription": "This filter will match all critical event generated in any
of the managed endpoints or the manage server itself.",
"eventFilterName": "Match All Critical",
"isEditable": false,
"isDeletable": false,
"isUsed": true,
"lockedPredefinedFilter": true,
"matchEveryCoreEvent": false,
"matchEverySystem": true,
"matchEverything": false
},
{
"eventFilter": {
"filter": {
"categories": ["GENERAL"],
"componentIDs": [],
"sourceIDs": [],
"typeSeverity": [{
"severity": "WARNING",
"type": "UNKNOWN"
},
...,
{
"severity": "MINOR",
"type": "SWITCH"
}]
}
},
"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
}],
"lastPushEventID": "FQXHMEM0405I",
"lastPushStatus": "Failure : java.net.SocketTimeoutException: Read timed out",
"lastPushTimeStamp": "2017-03-29T15:16:30Z",
"phoneUID": "5d57a0 ... 17b656",
"registrationID": "5d57a05de25b7b91344931a91a64f0157bcaa834c8e6afe758e3f93da317b656",
"subscriberCategory": "iOS Subscriber",
"subscriberCategoryExplanation": "This is a Apple Phone Subscriber"
"uid": "2",
"userName": "USERID"
}]