Skip to main content

GET /notificationsLicense/warning_period

Use this method to return the license warning period, which determines the number of days before license expire when Lenovo XClarity Administrator triggers a warning.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/notificationsLicense/warning_period

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

ParametersTypeDescription
responseArray of objects 
 warning_periodStringNumber of days before license expire when XClarity Administrator triggers a 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": [{
      "warning_period": 90
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}