...
Parameter | Required | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${featureId} | Yes | integer | Specifies ID of the feature for which you want to view denied requests. | ||||||||||||||||
${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls or pdf. | ||||||||||||||||
sd | Yes | string | Specifies the starting date from which you want to generate the report. The date and time format is YYYY-MM-DD; for example, 2017-01-20. | ||||||||||||||||
ed | Yes | string | Specifies the end date from which you want to generate the report. The date and time format is YYYY-MM-DD; for example, 2017-01-20. The date is inclusive, meaning that all data from a 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 XLS. For CSV and JSON formats this parameter will be ignored. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty. | ||||||||||||||||
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:
| ||||||||||||||||
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 an ascending (ASC) or a descending (DESC) order. |
...
Field | Type | Description |
---|---|---|
un | string | Username. |
hn | string | Hostname. |
ldt | string | License Denial Time in YYYY-MM-DD format Date on which the denial took place in YYYY-MM-DD format?. |
ldtc | string | Total number of denied license checkout requests.License Denial Total Count. |
msg | string | Error message returned on failure. |
success | boolean | Indicates whether the API request was successfully processed. |
code | integer | Error code if success == falseError code for unsuccessful request.? |
totalCount | integer | Total number of all matching results. Count of all matching results. |
Example 1
Say you would like to view denials for feature 3 over some period of time. To generate such data, enter a command similar to the following:
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "orderBy=un" --data "orderDirection=ASC" --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json" |
Example 3
Let's say Say you're interested in viewing the first 100 denials for feature 3 over a specific period of time. To do this, enter a command that is similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "limit=100" --data "offset=0" --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json" |
...
json" |
Keep in mind that you can also put parameters directly into the URL, e.g. to generate data for the above example, the command would look like this:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json?limit=100&offset=0&sd=2014-12-01&ed=2015-01-02" |
...
Field | Type | Description |
---|---|---|
ldt | 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. |
ldtc | string | License Denial Total CountTotal number of denied license checkout requests. |
msg | string | Error message returned on failure. |
success | boolean | Indicates if the API request was successfully processed. |
msg | string | Error message returned on failure. |
code | integer | Error code if success == falseError code for unsuccessful request.? |
totalCount | integerCount of all matching results. | Total number of denied license checkout requests. |
Example 1
Say you would like to view denials for feature 3 grouped by month. To generate such data, enter a command similar to this one:
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "limit=100" --data "offset=0" --data "sd=2013-01-01" --data "ed=2015-01-02" --data "grat=6" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json" |
...
Keep in mind that you can also put parameters directly into the URL, e.g. to generate data for the above example, the command would look like this:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json?limit=5&offset=2&sd=2013-01-01&ed=2015-01-02&grat=6" |