GET /quantityLicense
Use this method to return information about all installed licenses.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/quantityLicense
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
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.
| ||
| 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.
| ||
| result | String | Results of the request. This can be one of the following values.
| ||
| 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.
{
"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": ""
}]
}
Give documentation feedback