PUT /notificationsLicense/warning_period

Use this PUT method to modify the license warning period, which determines the number of days before license expire when XClarity Orchestrator triggers a warning.

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

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/notificationsLicense/warning_period

Query parameters

None

Request body

Parameter Required / Optional Type Description
warning_period Required Integer Number of days before license expire when XClarity Orchestrator triggers a warning

Request example

Response codes

Code Description
200 OK
400 Bad request
500 Internal server error

Response body

Parameters Type Description
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

{
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}