This operation returns the licenses that are applied to a client.
Request
Syntax
GET <webservice>/Client/{clientId}/License HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
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 Parameters
Name | Description | Required |
clientId | The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. | Yes |
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. |
Response
Response Parameters
Parameter | Description | Element |
platformType | An internal ID number. Valid values are:
| licensesInfo |
appType | An internal ID number. | license |
licenseName | The name of the license applied to the client. | license |
licenseType | The ID number for the license. | license |
Examples
Sample Request
GET <webservice>/Client/24/License HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
XML
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GetConsumedLicenseResp>
<licensesInfo platformType="1">
<license appType="33" licenseName="Server File System - Windows File System" licenseType="1"/>
</licensesInfo>
<licensesInfo platformType="2">
<license appType="1002" licenseName="MediaAgent - MediaAgent Management" licenseType="11"/>
</licensesInfo>
<licensesInfo platformType="2">
<license appType="1020" licenseName="Disk Library Connector (DDO) - Magnetic Library" licenseType="84"/>
</licensesInfo>
<licensesInfo platformType="2">
<license appType="1100" licenseName="De-Duplication Block Level - Block Level De-Duplication" licenseType="168"/>
</licensesInfo>
</TMMsg_GetConsumedLicenseResp>
JSON
{
"licensesInfo": [{
"platformType": 1,
"license": {
"licenseType": 1,
"appType": 33,
"licenseName": "Server File System - Windows File System"
}
}, {
"platformType": 1,
"license": {
"licenseType": 3,
"appType": 81,
"licenseName": "Application Class 1 - SQL Server"
}
}, {
"platformType": 1,
"license": {
"licenseType": 143,
"appType": 106,
"licenseName": "Virtual Server - Virtual Server"
}
}, {
"platformType": 1,
"license": {
"licenseType": 171,
"appType": 121,
"licenseName": "Metrics Reporting Server - Metrics Reporting Server"
}
}, {
"platformType": 2,
"license": {
"licenseType": 11,
"appType": 1002,
"licenseName": "MediaAgent - MediaAgent Management"
}
}, {
"platformType": 2,
"license": {
"licenseType": 84,
"appType": 1020,
"licenseName": "Disk Library Connector (DDO) - Magnetic Library"
}
}, {
"platformType": 2,
"license": {
"licenseType": 168,
"appType": 1100,
"licenseName": "De-Duplication Block Level - Block Level De-Duplication"
}
}]
}