...
| Code Block | ||
|---|---|---|
| ||
GET /api/v1/report/current-usage/on-multiple-hosts/${returnType}?(parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and . The possible parameters can be explained as followsare described below.
| Parameter | Required | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls, xslx or pdf. | ||||||||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
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 a string column, use the following format.
To filter by a numeric column, use the following format.
| ||||||||||||||
| 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 (See this section for more field-specific information.) | ||||||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
Response
The following code block shows an example result of a successful request.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
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}
} |
...
| 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 | List of hostnames separated by a semicolon (;). |
| uil | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |
| msg | string | Error message returned on failure. |
| success | boolean | Indicates wheher your API request was successfully processed. |
Example
Say you would like to obtain The following example shows a command that obtains information about users using features on multiple hosts. To generate this data set, enter a command similar to the following.
| Code Block |
|---|
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/on-multiple-hosts/json" |
...
| Code Block | ||
|---|---|---|
| ||
GET /api/v1/report/current-usage/above-n-hours/${returnType}?ab=${hoursAbove}&bl=${hoursBelow}&(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and . The possible parameters can be explained as follows: are described below.
Parameter | Required | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls, xslx or pdf. | ||||||||||
| ab | No | integer | Specifies the minimum number of hours a license has to be used to be listed. If not provided is defaults to value "-1" which is equivalent of to no constraint. | ||||||||||
| bl | No | integer | Specifies the maximum number of hours a license can has to be used to be listed. If not provided is defaults to value "-1" which is equivalent of to no constraint. Value must be greater than value of 'ab' parameter (does not apply for "-1" values). | ||||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
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 a string column, use the following format:
To filter by a numeric column, use the following format:
| ||||||||||
| 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, hn, lus, tu (See this section for more field-specific information.) | ||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
Response
The following code block shows an example result of a successful request.
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"vn": ${vendorName},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"uid": ${userId},
"un": ${userName},
"hn": ${hostName},
"lus": ${licensesUsed},
"tu": ${timeUsed},
"uil": ${ldapUser},
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows: Anchor fields def fields def
Field | Type | Description |
|---|---|---|
| fid | integer | Feature ID. |
| fns | string | Feature Name. |
| fv | string | Feature version. |
| ftype | string | Feature type. |
vn | string | Vendor name. |
| lsid | integer | License Server ID. |
| lsn | string | License Server name. |
| uid | integer | User ID. |
un | string | Username. |
hn | string | Hostname. |
lus | integer | Total number of licenses used by user on host. |
tu | string | Indicates how long license has been in use, f.e 1d 2h 10 min. Note that you cannot filter on this field |
uil | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |
msg | string | Error message returned on failure. |
success | boolean | Indicates whether your API request was successfully processed. |
| code | integer | Error code for unsuccessful request. |
| totalCount | integer | Total number of all matching results. |
Example
Say you would like to download The following example shows a command that downloads data in a CSV file format about features currently in use for at least 24 hours. To generate this data set, enter a command similar to the following.
| Code Block | ||
|---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/above-n-hours/csv?ab=24" |