Skip to main content

PUT /events/notifications/subscriptions

Use this method to modify a subscription that is used to forward events to mobile devices or WebSocket service.

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/events/notifications/subscriptions

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDefinition
actionRequiredStringAction to perform. This can be one of the following values.
  • edit. Modify the subscription properties
classRequiredStringType of subscription. This can be one of the following values.
  • AndroidSubscriber. Forwards events to a Google device.
  • iOSSubscriber . Forwards events to an Apple device.
  • WebSocketSubscriber . Forwards events to a WebSocket service.
filterListRequiredArray of objectsOne or more filters. This can be a predefined filter or a full description of a new filter.
 filterRequired if predefinedFilterName is not specifiedObjectInformation about the filters
  eventFilterOptionalArray of objectsInformation about the types of events to filter.
   filterOptionalObjectInformation about each event filter
    categoriesOptionalArray 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.
    componentIDsOptionalArray of stringsList of component IDs. If empty, all components are accepted.
    sourceIDsOptionalArray of stringsList of source IDs. If empty, all sources are accepted.
    typeSeverityOptionalArray of objectsEvent severity and type

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

     severityOptionalStringEvent 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.
     typeOptionalStringEvent 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
  eventFilterDescriptionOptionalStringFilter description
  eventFilterNameOptionalStringFilter name
 matchEveryCoreEventOptionalBooleanIndicates whether this event filter accepts all core events
 matchEverySystemOptionalBooleanIndicates whether this event filter must match every event from every managed device
 matchEverythingOptionalBooleanIndicates whether this event filter matches all events
 predefinedFilterNameRequired if filter is not specifiedStringThe name of predefined event filter. This can be one of the following values:
  • Match All Critical
  • Match All Warning
phoneUIDRequiredString(Android and iOS push services only) The displayable phone ID
preferredLanguageOptionalStringPreferred language for the push notification payload. This can be one of the following values:
  • en. English
  • de. German
  • es. Spanish
  • fr. French
  • it. Italian
  • ja. Japanese
  • ko. Korean
  • pt. Brazilian Portuguese
  • zh. Simplified Chinese
  • zh-hant. Traditional Chinese
registrationIDOptionalString(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.
The following example modifies a subscription that is used to forward events to mobile devices or WebSocket service.
{
    "action": "add"
    "class": "AndroidSubscriber",   
    "filterList": [{ 
      "predefinedFilterName": "Match All Critical"
   }],
   "phoneUID": "fr2Z6X ... mwgqqs",
   "preferredLanguage": "en",
   "registrationID": "fr2Z6X5_w38:APA91bEkN1J0nMFxZmcLuT4NMOWvFGJ0TTZsUTrXmYmmCzLddf
                      _iD7tfnovHqzB0wqIz5mfwg9JBSLL0A96DdqDRby92ld2_FfwRf4T8ef_AGLydq
                      D0fd3F_faIXYmWQmW0Fymwgqqs"
}

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​

None