PATCH /authCodes/{code}

Use this method to install or download license-activation keys for a specific authorization code.

Note: This REST API requires Lenovo XClarity Administrator v3.5.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

PATCH https://{management_server_IP}/authCodes/{code}/licenseKeys

where {code} is the authorization code ID which was sent to you in an electronic proof of entitlement email when you purchased the licenses.

Query parameters

None

Request body

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

Attributes Type Description
response Array of objects Information about each license-activation key
  result String Request status for the key
  filename String File name for the license-activation keys
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.
{
   "response": [{
      "result": "OK",
      "filename": "lnvgy_fod_0038_7777777777_anyos_noarch_00000011_1337.key"
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "explanation": "",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      }
   }]
}