GET /quantityLicense

Use this GET method to retrieve information about all installed licenses.

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

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/quantityLicense

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
409 Conflict
500 Internal server error

Response body

Parameters Type Description
messages Array of objects Information about each license
  end_date String Date when the license ends
  enterprise Boolean Indicates whether this is an enterprise license. This can be one of the following values.
  • true. This is an enterprise license.
  • false. This is a standard license.
  id Integer License ID
  product String Product license name
  product_description String Product license description
  quantity Integer Number of devices that can be managed under this license
  start_date String Date when the license starts
  valid Integer License status. This can be one of the following values.
  • 0. The license is not valid.

  • 1. The license is valid.

  • 2. The license is about to expire.

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

{
   "response": [{
      "end_date": "02/25/2019",
      "enterprise": false,
      "id": 1,
      "product": "00MT201",
      "product_description": "Lenovo xClarity Pro per Managed Server for 1 year",
      "quantity": 80,
      "start_date": "02/25/2018"
      "valid": 0,
   },
   ...,
   {
      "end_date": "12/30/2019",
      "enterprise": false,
      "id": 3,
      "product": "00MT201",
      "product_description": "Lenovo xClarity Pro per Managed Server for 1 year",
      "quantity": 30,
      "start_date": "12/30/2018"
      "valid": 0,
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}