...
Parameter | Required | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${licenseServerId} | Yes | integer/string | Specifies ID of license server for which we want to gather data about features nearing expiration. You can set this parameter to 'all' to gather data from all license servers. | ||||||||||||||||||
${returnType} | Yes | string | Specifies the format in which license data will be returned. The format can be one of the following: JSONjson, CSVcsv, XLSXxlsx, or PDFpdf. | ||||||||||||||||||
sd | No | string | Specifies the start date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-20. If neither this field, nor "ed" is provided, it defaults to today. | ||||||||||||||||||
ed | No | string | Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27. If neither this field, nor "sd" is provided, it defaults to [today + 12 months]. | ||||||||||||||||||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. For CSV and JSON, this parameter will be ignored. | ||||||||||||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter by a string column, use the following format:
To filter by a 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. | ||||||||||||||||||
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: fid | fns | fv | ftype | vn | lsn | fexp (See this section for more field-specific information.) | ||||||||||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or descending (DESC) order. |
...