...
Parameter | Required | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
${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. | |||||||||
fns | No | string | Applies quick filtering on a feature name. | |||||||||
fv | No | string | Applies quick filtering on a feature version. | |||||||||
ftype | No | string | Applies quick filtering on a feature type. | |||||||||
lsn | No | string | Applies quick filtering on a license server name. | |||||||||
vn | No | string | Applies quick filtering on a license server vendor name. | |||||||||
gtn | No | string | Applies quick filtering on a license server gathering type. | |||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
limit | No | integer | Specifies the number of records that must 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, lsid, lsn, vn, gtn. | |||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
Note: By default, filter rules are case-insensitive.
Response
The response you get may be similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ success: true, msg: ${message}, data: [{ fid: ${featureId}, fns: ${featureName}, fv: ${featureVersion}, ftype: ${featureType}, lsid: ${licenseServerId}, lsn: ${licenseServerName}, vn: ${licenseServerVendorName}, gtn: ${licenseServerGatheringType} }] } |
...