...
Parameter | Required | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: jsonJSON, csvCSV, xlsXLSX, xslx or pdfPDF. | ||||||||||||||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. 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. | ||||||||||||||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLSXLSX. 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 XLSX types. If provided, it cannot be left empty. | ||||||||||||||
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.
| ||||||||||||||
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, lsid, lsn, uid, un, hl (See this section for more field-specific information.) | ||||||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
...
Parameter | Required | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: jsonJSON, csvCSV, xlsXLSX, xslx or pdfPDF. | ||||||||||
ab | No | integer | Specifies the minimum number of hours a license has to be used to be listed. If not provided is defaults to value "-1" which is equivalent to no constraint. | ||||||||||
bl | No | integer | Specifies the maximum number of hours a license has to be used to be listed. If not provided is defaults to value "-1" which is equivalent to no constraint. Value must be greater than value of 'ab' parameter (does not apply for "-1" values). | ||||||||||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. 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. | ||||||||||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLSXLSX. 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 XLSX types. If provided, it cannot be left empty. | ||||||||||
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:
| ||||||||||
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, lsid, lsn, uid, un, hn, lus, tu (See this section for more field-specific information.) | ||||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
...