...
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}
} |