...
Parameter | Required | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${featureId} | Yes | integer | Specifies feature-specific parameters. | ||||||||||
${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. | ||||||||||
sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-20. | ||||||||||
ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-27. | ||||||||||
granularity | Yes | integer | Specifies granularity of the returned data; Can be one of the following:
| ||||||||||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or Excel. | ||||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter by string column, use the following format:
To filter by numeric column, use the following format:
| ||||||||||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible, ''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. | ||||||||||
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:
lud | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft | ||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
If your request is successful, you should see a response similar to the following:
Code Block | ||
---|---|---|
| ||
{ "success": ${success}, "msg": ${message}, "data": [ { "fid": ${featureId}, "lud": ${date}, "lumin": ${minUsed}, "lua": ${averageUsed}, "lumax": ${maxUsed}, "lbmin": ${minBorrowed}, "lbmax": ${maxBorrowed}, "ldtc": ${denials}, "hu": ${hoursUsed}, "ft": ${total} } ], "code": ${code}, "totalCount": ${count} } |
where the response fields can be explained as follows:
...
If your request is successful, you should see a response similar to the following:
Code Block | ||
---|---|---|
| ||
{ "success": ${success}, "msg": ${message}, "data": [ { "fid": ${featureId_1}, "lud": ${date}, "lumin": ${minUsed}, "lua": ${averageUsed}, "lumax": ${maxUsed}, "lbmin": ${minBorrowed}, "lbmax": ${maxBorrowed}, "ldtc": ${denials}, "hu": ${hoursUsed}, "ft": ${total} }, { "fid": ${featureId_2}, "lud": ${date}, "lumin": ${minUsed}, "lua": ${averageUsed}, "lumax": ${maxUsed}, "lbmin": ${minBorrowed}, "lbmax": ${maxBorrowed}, "ldtc": ${denials}, "hu": ${hoursUsed}, "ft": ${total} } ], "code": ${code}, "totalCount": ${count} } |
The meaning of all fields are the same as in Usage History For Feature.
...
Parameter | Required | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${lsid} | Yes | integer | License Server Id. | ||||||||||
${returnType} | Yes | string | See Usage History For Feature. | ||||||||||
sd | Yes | string | See Usage History For Feature. | ||||||||||
ed | Yes | string | See Usage History For Feature. | ||||||||||
granularity | Yes | integer | See Usage History For Feature. | ||||||||||
rn | No | string | See Usage History For Feature. | ||||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter by string column, use the following format:
To filter by numeric column, use the following format:
| ||||||||||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible, ''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. | ||||||||||
limit | No | integer | See Usage History For Feature. | ||||||||||
offset | No | integer | See Usage History For Feature. | ||||||||||
orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: lud | fns | fv | ftype | fid | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft | ||||||||||
orderDirection | No | string | See Usage History For Feature. |
If your request is successful, you should see a response similar to the following:
Code Block | ||
---|---|---|
| ||
{ "success": ${success}, "msg": ${message}, "data": [ { "fid": ${featureId_1}, "lud": ${date}, "lumin": ${minUsed}, "lua": ${averageUsed}, "lumax": ${maxUsed}, "lbmin": ${minBorrowed}, "lbmax": ${maxBorrowed}, "ldtc": ${denials}, "hu": ${hoursUsed}, "ft": ${total}, "fns": ${featureName}, "ftype": ${featureType}, "fv": ${featureVersion} }, { "fid": ${featureId_1}, "lud": ${date}, "lumin": ${minUsed}, "lua": ${averageUsed}, "lumax": ${maxUsed}, "lbmin": ${minBorrowed}, "lbmax": ${maxBorrowed}, "ldtc": ${denials}, "hu": ${hoursUsed}, "ft": ${total}, "fns": ${featureName}, "ftype": ${featureType}, "fv": ${featureVersion} } ], "code": ${code}, "totalCount": ${count} } |
where the response fields can be explained as follows:
Field | Type | Description |
---|---|---|
success | boolean | This field indicates that the API request was successfully processed. |
msg | string | Error message returned on failure. |
fid | integer | Feature Id |
lud | string | For Granularity hour - Datetime, for rest Date, which indicates point int time that data are about. |
lumin | integer | Minimal licenses used count for given date. |
lua | float | Average licenses used count for given date. |
lumax | integer | Maximum licenses used count for given date. |
lbmin | integer | Minimal licenses borrowed count for given date. |
lbmax | integer | Maximum licenses borrowed count for given date. |
ldtc | integer | Denials count. |
hu | float | Hours used. |
ft | integer | Total. |
code | integer | Error code if success == false, null otherwise. |
totalCount | integer | Total number of rows returned. |
fns | string | Feature name. |
ftype | string | Feature tyep. |
fv | string | Feature version. |