GET /notificationsLicense

Use this method to retrieve information about warnings regarding non-compliance of installed licenses.

Note: This API requires Lenovo XClarity Administrator v2.7.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/notificationsLicense

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
404 Not found
409 Conflict
413 Request Entity Too Large
500 Internal server error

Response body

Parameters Type Description
response Array of objects Information about non-compliance for each license
  accepted_eula String Indicates whether the end-user license agreement was accepted. This can be one of the following values.
  • 0. License agreement was not accepted.
  • 1. License agreement was accepted.
  active_entitlements String Total number of active licenses
  compliant String Indicates whether XClarity Administrator is compliant with installed licenses. This can be one of the following values.
  • 0. XClarity Administrator is not compliant with installed licenses. The number of devices exceeds the permissible limit.
  • 1. XClarity Administrator is compliant with installed licenses. The number of devices does not exceed the license limit.
  • 2. XClarity Administrator is compliant with installed licenses. The number of devices exceeds the license limit but does not exceed the permissible limit.
  enable_functions String Indicates whether licensed functions are enabled. This can be one of the following values.
  • 0. Licensed functions are disabled.
  • 1. Licensed functions are enabled.
  expiring_soon String Indicates whether any licenses will expire in 90 days or less. This can be one of the following values.
  • 0. Licenses will expire soon.
  • 1. Licenses will not expire soon.
  managed_devices String Total number of managed devices
  remaining_days Integer Number of days before licensed function is disabled
  notifications Array of objects Information about license notifications
    contact String Contact details
    description String Message description
    type String Type of the message. This can be one of the following values.
  • error

  • warning

result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
   "response": [{
      "accepted_eula": "0",
      "active_entitlements": "0",
      "compliant": "0",
      "enable_functions": "1",
      "expiring_soon": "0",
      "managed_devices": "1",
      "remaining_days": "89"
   },
   {
      "notifications": [{
         "contact": "To purchase additional licenses, contact your Lenovo representative or
                        authorized business partner. Learn more <a href=\"javascript:void(0);\"
                       class=\"helpWindow\" data-help-url=\"update_license.html\">here</a>",
         "description": "There are 0 active license keys that entitle licenses for 0 devices; 
                            however, 1 managed devices require licenses. You have 89 days remaining
                            to install the appropriate number of licenses to be in compliance.",
         "type": "warning"
      }]
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "explanation": "",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      }
   }]
}