PUT /warranty/settings

Use this method to modify global warranty settings.

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

Authentication

Authentication with user name and password is required.

Request URL

PUT https://{management_server_IP}/warranty/settings

Query parameters

None

Request body

Attributes Required / Optional Type Description
warrantyThreshold Required Integer Number of days before the warranty expires for a managed device when you want to be warned about the expiration. The default is 30 days.
The following example modifies the warranty threshold.
{
    "warrantyThreshold": 30
}

Response codes

Code Description Comments
200 OK The request completed successfully.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes 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
The following example is returned if the request is successful.
{
   "result": "success",
   "messages": [{
      "id": "FQXHMSS2080I",
      "text": "The Alert Period for warnings was updated successfully.",
      "recovery": {
         "text": "",
         "url": ""
      },
      "explanation": ""
   }]
}