GET /events/notifications/subscriptions

Use the GET method to retrieve information about all subscriptions.

Note: This API requires Lenovo XClarity Administrator v1.3.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/events/notifications/subscriptions

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
400 Bad request
401 Unauthorized.
500 Internal server error

Response body

Attributes Type Definition
filterList Array of objects List of 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.
  • GENERAL
  • STATUS_CHANGE
  • STATUS_UPDATE
  • WARRANTY
      componentIDs Array of strings List of component IDs. 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 is 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. switch
  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 Lenovo XClarity Administrator
  name String User-defined name of the event filter. This must be unique for all filters.
  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
lastPushEventID String ID of the last pushed event
lastPushStatus String Status of the last push attempt
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

Response example

[{
   "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",
      "isDeletable": false,
      "isEditable": 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",
      "isDeletable": false,
      "isEditable": false,
      "isUsed": true,
      "lockedPredefinedFilter": true,
      "matchEveryCoreEvent": false,
      "matchEverySystem": true,
      "matchEverything": false
   }],
   "lastPushEventID": "FQXHMEM0406I",
   "lastPushStatus": "Success",
   "lastPushTimeStamp": "2017-03-29T15:09:16Z",
   "phoneUID": "cl8SqE ... KXbXR3",
   "registrationID": "cl8SqERZpSQ:APA91bGfoNOCA0syHZTq4epEF8b0fYbx-hpJFRZqhDZ4SJwC5rQUmgZG8Ztz0Fty   
                      2VqaWIV_oU6GLnYeHNXJdPXjX8QRW9_blAwdiTVA_vtblM0xVYZUwP20WYtFhi2CMb5RufKXbXR3",
   "subscriptionCategory": "Android Subscription",
   "subscriptionCategoryExplanation": "This is a Google Phone Subscription",
   "uid": "1",
   "userName": "USERID"
},
{
   "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",
      "isDeletable": false,
      "isEditable": 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",
      "isDeletable": false,
      "isEditable": 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",
   "subscriptionCategory": "iOS Subscription",
   "subscriptionCategoryExplanation": "This is a Apple Phone Subscription",
   "uid": "2",
   "userName": "USERID"
}]