...
Parameter | Required | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${featureId} | Yes | integer | Specifies feature-specific parameters. | ||||||||||
${returnType} | Yes | string | Specifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf. | ||||||||||
sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. | ||||||||||
ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. | ||||||||||
granularity | Yes | integer | Specifies granularity of the returned data and , which 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 XLS. For CSV and JSON formats this parameter will be ignored. | ||||||||||
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, like this:
where "1" indicates that a specific field is visible and ''0" indicates that 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. |
...
Field | Type | Description |
---|---|---|
success | boolean | Indicates that your API request was successfully processed. |
msg | string | Error message returned on failure. |
fid | integer | Feature ID. |
lud | string | Indicates period of time for which usage information is generated, i.e. date and time for hourly usage and dates for the remaining granularity options. |
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 | Feature total. |
code | integer | Error code. On success, it equals false ; otherwise it. Otherwise the value is null. |
totalCount | integer | Total number of rows returned. |
...
Field | Type | Description |
---|---|---|
success | boolean | Indicates that the API request was successfully processed. |
msg | string | Error message returned on failure. |
fid | integer | Feature ID. |
lud | string | Indicates period of time for which usage information is generated, i.e. date and time for hourly usage and dates for the remaining granularity options. |
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 | Feature total. |
code | integer | Error code. On success, it equals false; otherwise it . Otherwise the value is null. |
totalCount | integer | Total number of rows returned. |
fns | string | Feature name. |
ftype | string | Feature type. |
fv | string | Feature version. |
...