...
| Code Block | ||
|---|---|---|
| ||
GET /api/v1/report/license-server-group/${lsgid}/current-usage/${returnType} |
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
| Parameter | Required | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${lsid} | Yes | integer | License Server ID. | ||||||||||||||||||
| ${lsgid} | Yes | integer | License Server Group ID. | ||||||||||||||||||
| ${returnType} | Yes | string | Specifies the format in which license usage 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:
where "1" indicates that a specific field is visible and ''0" indicates it is not. 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, fu, fbrwd, frvd, ft, futil, fexp, flu (See this section for more field-specific information.) | ||||||||||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or 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}",
"fu": "${licensesUsed}",
"fbrwd": "${licensesBorrowed}",
"frvd": "${licensesReservations}",
"ft": "${total}",
"futil": "${licenseUtilization}",
"fexp": "${expireDate}",
"flu": "${lastUsageUpdateDate}",
"fiexp": "${isExpired}"
}],
"code": ${errorCode},
"totalCount": ${totalNumberOfRecords}
} |
...
Note: Data returned for a license server group consists of a summary of all features of all license servers in the group, including hidden ones. (See License server groups for more information.)
Example 1
Say you want to download data in XLS format The following example shows a command that downloads data about current usage for license server "7". To generate this data set, enter a command similar to the following in XLS format.
| Code Block | ||
|---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/7/current-usage/xls" |
Example 2
If you want to obtain The following example shows a command that obtains information about features with current usage higher than 90% for license server "13.", enter the following command.
| Code Block | ||
|---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/13/current-usage/json" --data-urlencode 'filters=[{"type":"numeric","comparison":"gt","field":"futil","value":"90"}]' |
Example 3
Let's assume you want to download data in a CSV file The following example shows a command that downloads data about current usage for license server group "1". To generate this data set, enter a command similar to the following in CSV format.
| Code Block | ||
|---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server-group/13/current-usage/csv" |
...