...
| returnType | Yes | string | Specifies the format in which license usage data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf. | ||
| sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. | ||
| ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. | ||
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS/XLSX. For CSV and JSON formats this parameter will be ignored. | ||
| filter | No | json/string | Applies filtering license usage data on all fields. To filter by string 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. 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. | ||
| 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: uid | un | hnIf orderBy is provided, orderDirection is mandatory. | ||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. If orderDirection is provided, orderBy is mandatory. |
...
| Field | Type | Description |
| uid | integer | User ID. Note that you cannot filter and order data by this field. |
un | string | Username. |
hn | string | Hostname. |
uil | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |
msg | string | Error message returned on failure. |
success | boolean | Indicates whether the API request was successfully processed. |
| code | integer | Error code for unsuccessful request. |
| totalCount | integer | Total number of all matching results. |
...