This operation reapplies a license to a CommCell entity. This operation consumes a license for the selected entity.
Request
Syntax
Send the request using either XML or JSON:
XML
POST <webservice>/Client/License/Reconfigure HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<reconfigure_license_template.xml>JSON
POST <webservice>/Client/License/Reconfigure HTTP/1.1
Host: <host name>
Accept: application/json
Authtoken: <authentication token>
Content-type: application/json
<reconfigure_license_template.json>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type | The media type contained in the request body. |
Request Body
Download the XML or JSON file required for this request: reconfigure_license_template.xml or reconfigure_license_template.json. The following table displays the parameters for the request body.
Name | Description | Element | |||
|---|---|---|---|---|---|
clientId | The system-generated ID assigned to the client. If the client ID is not known, use the GET Client API to retrieve it. | clientInfo | |||
val (Used with XML) | An internal ID number. Use this parameter to reapply a license to a client. Valid values are:
| platformTypes | |||
platformTypes (Used with JSON) | An internal ID number. Use this parameter to reapply a license to a client. Valid values are:
|
| |||
platform | An internal ID number. Use this parameter to reapply a license to an agent. Valid values are:
| appTypes | |||
applicationId | The ID of the application (agent). This is required if the platform parameter is set to 1. Valid values are:
|
Response
Response Parameters
Parameter | Description | Element |
|---|---|---|
errorCode | The possible error codes. Valid values are:
| CVGui_GenericResp |
errorMessage | The description of the error code. Not all error codes have an error message. | CVGui_GenericResp |
Examples
Sample Request
XML
This request reapplies a license to a file system agent.
POST <webservice>/Client/License/Reconfigure HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<TMMsg_LicenseReconfigurationReq>
<clientInfo clientId ="18"/>
<platformTypes val ="1"/>
</TMMsg_LicenseReconfigurationReq>JSON
This request reapplies a license to a client.
POST <webservice>/Client/License/Reconfigure HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
{
"clientInfo": {
"clientId": 2
},
"platformTypes": [
1, 2
]
}Sample Response
XML
<CVGui_GenericResp errorCode="0" errorMessage=""/>JSON
{
"errorMessage":"","errorCode":0
}