Skip to main content

GET /notificationsLicense

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

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/notificationsLicense

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.
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
413Request Entity Too LargeClients might impose limitations on the length of the request URI, and the request URI is too long to be handled. 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​

ParametersTypeDescription
responseArray of objectsInformation about non-compliance for each license
 accepted_eulaStringIndicates 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_entitlementsStringTotal number of active licenses
 compliantStringIndicates 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_functionsStringIndicates whether licensed functions are enabled. This can be one of the following values.
  • 0. Licensed functions are disabled.
  • 1. Licensed functions are enabled.
 expiring_soonStringIndicates 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_devicesStringTotal number of managed devices
 remaining_daysIntegerNumber of days before licensed function is disabled
 notificationsArray of objectsInformation about license notifications
  contactStringContact details
  descriptionStringMessage description
  typeStringType of the message. This can be one of the following values.

  • error

  • warning

resultStringResults 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.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
   "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="\&quot;javascript:void(0);\&quot;" data-help-url="\&quot;update_license.html\&quot;" className="\&quot;helpWindow\&quot;">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": ""
      }
   }]
}