...
Parameter | Required | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
licenseServerId | Yes | array | Arrays of feature IDs in the following format: id1, id2, id3... for example fi=1,2,3,5. | ||||||||||||||||||
sd | No | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. If not provided defaults to today. | ||||||||||||||||||
ed | No | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. If not provided defaults to [today + 12 months] | ||||||||||||||||||
granularity | No | integer | Specifies granularity of the returned data, and can be one of the following:
By default, this parameter is set to "Month"show monthly usage. | ||||||||||||||||||
filter | No | 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:
|
...
Field | Type | Description |
---|---|---|
success | boolean | Indicates that your API request was successfully processed. |
msg | string | Error message returned on failure. |
fexpy | integer | Year for which the period number has been specified. |
fexpm | integer | Number of time period such as day, week, month, etc. |
fexpc | integer | Count of features expiring features in the given period of time. |
granularity | integer Period granularity: | Specifies granularity of the returned data, and can be one of the following:
|
code | integer | Error code if success equals false, null otherwise. |
totalCount | integer | Total number of rows returned. |
Example 1
For example, say If you would like to get obtain count of features that expire every month in the next 12 months on all your servers. To generate such data, enter a command that is similar to the following:
Code Block | ||
---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/count/grouped/json" |
Example 2
For example, say Say you would like to get obtain count of features that expire every week in some period of time on server with id ID 1. To generate such data, enter a command that is similar to the following:
Code Block | ||
---|---|---|
| ||
curl --data "sd=2015-01-01" --data "ed=2015-03-01" --data "granularity=4" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/count/grouped/json" |
...