With License Statistics API, you can easily generate information about Current Usage On Multiple Hosts, that is which licenses are used by the same user on multiple hosts.
Obtaining information about usage on multiple hosts
If you want to see which users are using licenses on multiple hosts, we recommend that you use the following URL request template.
GET /api/v1/report/current-usage/on-multiple-hosts/${returnType}?(parameters, as needed)
where
- $ indicates a variable value that you can replace with a proper value, according to your needs
- the possible parameters are as follows:
| Parameter | Required | Type | Descrption |
|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls or pdf. |
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example: {"un": "1", "hl": "1", "fns": "1", "fv":"1"}
where number "1" indicates that a specific field is visible. Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here. |
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty. |
| filter | No | json/string | Applies filtering license usage data on all fields. To filter by string column, use the following format: [
{
"type": "string",
"field": "${ fns | fv | ftype | vn | lsn | un | hl }",
"value": "${value}"
}
]
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${ fid, lsid, uid }",
"value": "${value}"
}
]
|
| limit | No | integer | Determines the maximum number of data records that can be returned. The value must be greater than zero. |
| offset | No | integer | Specifies the offset of the first row to return. |
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: fid, fns, fv, ftype, vn, lsid, lsn, uid, un, hl |
| orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"vn": ${vendorName},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"uid": ${userId},
"un": ${userName},
"hl": ${hostList},
"uil": ${hasUserLdapDetails}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
}
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| fid | integer | Feature ID. |
| fns | string | Feature name. |
| fv | string | Feature version. |
| ftype | string | Feature type. |
| vn | string | License server vendor name. |
| lsid | integer | License server ID. |
| lsn | string | License server name. |
| uid | integer | User ID. |
| un | string | Username. |
| hl | string | Semicolon separated list of hostnames. |
| uil | boolean | Indicates whether user details have been imported from LDAP directory. Note that you cannot filter and order data by this field. |
| msg | string | Error message returned on failure. |
| success | boolean | Indicates that the API request was successfully processed. |
Example
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/on-multiple-hosts/json"