...
| 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 starting date from which you want to generate the report. The date and time format is as follows: YYYY-MM-DD, for example, 2015-01-20. | |||||||||
| ed | Yes | string | Specifies end date from which you want to generate the report. Date format as above. Date is inclusive, meaning all data from the particular day will be included in the report. | |||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. | |||||||||
| 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 denials data on all fields. To filter your data, 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: un, hn, ldt, ldtc. | |||||||||
| 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:
...
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
uid | integer | User Id. |
un | string | Username. |
hn | string | Hostname. |
ldt | string | License denial time in YYYY-MM-DD HH:MM format |
ldtc | string | License denial total count |
msg | string | Error message returned on failure. |
success | boolean | This field indicates that the API request was successfully processed. |
Example 1
For example, say you would like to view denials for feature 3 over some period of time. To generate such data, enter a command that is similar to the following:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/denials/3/json" |
...