Skip to main content

GET /licenseCompliance

Use this method to return information about whether Lenovo XClarity Administrator is license compliant.

Authentication​

Authentication with username and password is required.

Request URL​

GET https://{management_server_IP}/licenseCompliance

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
403ForbiddenThe 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.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

ParametersTypeDescription
responseArray of objectsInformation about compliance for each license
 compliantIntegerIndicates whether XClarity Administrator is compliant with installed licenses. This can be one of the following values.
  • 0. XClarity Administrator is not compliant.
  • 1. XClarity Administrator is compliant.
  • 2. XClarity Administrator is registered.
resultStringResults 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.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
   "response": [{
      "compliant": 1
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}