GET /warranty

Use this method to return or download the warranty information.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/warranty

Query parameters

Parameters	Required / Optional	Description
formatType=csv	Optional	Returns information in CSV format
outputFormat=v2	Optional	Returns warranty information for all device, whether they are covered under a warranty or not. If a device is not under warranty, the warrant type is Not Available.

The following example returns warranty information for devices that are covered under a warranty.

GET https://192.0.2.0/warranty

The following example returns a CSV file that contains warranty information for devices that are covered under a warranty.

GET https://192.0.2.0/warranty?formatType=csv

The following example returns warranty information for devices, including devices that are not covered under a warranty.

GET https://192.0.2.0/warranty?outputFormat=v2

Request body

None

Response codes

Code	Description	Comments
200	OK	The request completed successfully.

Response body

Table 1. Default output format
Attributes		Type	Description
children		Array of objects	Warranty information of each component of this device
	children	Array of objects	Warranty information for each component in this device, using the same attributes as the parent
	id	String	Component UUID
	deviceType	String	Component type. This can be one of the following values. nodes
detailsURL		String
deviceName		String	Device name
deviceType		String	Device type. This can be one of the following values. Chassis Edge Server. ThinkSystem SE server IBM Tape. IBM tape library Lenovo ThinkServer Lenovo Storage Rackswitch Rack-Tower Server. ThinkSystem SD, ThinkSystem SR, or ThinkSystem ST, System x, Converged, or NeXtScale server
endDate		String	Warranty end date
groupName		Array of strings	List of names of the resource groups to which the device belongs
groupUUID		Array of strings	List of UUIDs of the resource groups to which the device belongs
id		String	Device UUID
machineModel		String	Machine model
machineType		String	Machine type
serialNumber		String	Device serial-number Note For RackSwitch devices, this is the entitled serial number.
startDate		String	Warranty start date
status		String	Warranty status. This can be one of the following values. active expired NA. Not applicable
warrantyType		String	Warranty type. This can be one of the following values. 3PL 3XL MS12 NA. Not applicable

The following example is returned if the request is successful when the default output format is returned.

[{
   "children": [{
      "children": [{
         "children": [],
         "detailsURL": "compDetails/ITE/B672DEFF0F6C11E4A603DD6AA23A728A",
         "deviceName": "IMM2-40f2e990d8b1",
         "deviceType": "ITE",
         "endDate": "NA",
         "groupName": ["Not Available"],
         "groupUUID": [""],
         "id": 32184,
         "machineModel": "AC1",
         "machineType": "9532",
         "serialNumber": "DSYH03P",
         "startDate": "NA",
         "status": "NA",
         "warrantyType": "NA"
      }],
      "deviceType": "nodes",
      "id": "56"
   }],
   "deviceName": "MM5CF3FC25D733",
   "deviceType": "Chassis",
   "detailsURL": "compDetails/Chassis/3C8EEA1291FE4523985396B6266513FB",
   "endDate": "NA",
   "groupName": ["Not Available"],
   "groupUUID": [""],
   "id": 32183,
   "machineModel": "HC1",
   "machineType": "8721",
   "serialNumber": "23DWN32",
   "startDate": "NA",
   "status": "NA",
   "warrantyType": "NA"
}]

Table 2. V2 output format
Attributes	Type	Description
available	Boolean
children	Array of objects	Warranty information of each component of this device This object contains the same attributes as the top level attributes.
deviceName	String	Device name
deviceURI	String	Device URI
expirationDate	String	Warranty end date
groups	Array of strings	List of names of the resource groups to which the device belongs
groupsUUIDs	Array of strings	List of UUIDs of the resource groups to which the device belongs
mtm	String	Device machine type model
productName	String	Device product name
serialNumber	String	Device serial-number Note For RackSwitch devices, this is the entitled serial number.
startDate	String	Warranty start date
status	String	Warranty status. This can be one of the following values. active expired NA. Not applicable
uuid	String	Device UUID
warrantyNumber	String	Warranty type. This can be one of the following values. 3PL 3XL MS12 NA. Not applicable

The following example is returned if the request is successful when the default output format is returned.

{
   "available": true,
   "children": [{
      "available": true,
      "children": [],
      "deviceName": "Flex x240 M5 #1",
      "deviceURI": "/compDetails/ITE/22907D8F413811E7A840000E1E7D58F0",
      "expirationDate": "2020-05-27",
      "groups": [],
      "groupsUUIDs": [],
      "mtm": "9532/AC1",
      "productName": "Lenovo Flex System x240 M5 Compute Node",
      "serialNumber": "S40ET01",
      "startDate": "2017-05-28",
      "status": "Expired",
      "uuid": "22907D8F413811E7A840000E1E7D58F0",
      "warrantyNumber": "3XL"
   }],
   "deviceURI": "/chassisMap/2485D17451AD4590B236AD55DE77691B",
   "expirationDate": "2020-05-20",
   "groups": [],
   "groupsUUIDs": [],
   "deviceName": "Chassis.15",
   "mtm": "8721/HC2",
   "productName": "Lenovo Flex System Enterprise Chassis",
   "serialNumber": "S40EFR1",
   "startDate": "2017-05-21",
   "status": "Expired",
   "uuid": "2485D17451AD4590B236AD55DE77691B",
   "warrantyNumber": "3XL"
}

Give documentation feedback

GET /warranty

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​