...
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
| Parameter | Required | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${featureId} | Yes | integer | Specifies feature-specific parameters. | ||||||||||||||||||||
| ${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, pdf. | ||||||||||||||||||||
| sd | Yes | 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. | ||||||||||||||||||||
| ed | Yes | 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. | ||||||||||||||||||||
| grat | Yes | integer | Specifies granularity of the returned data, which can be one of the following:
| ||||||||||||||||||||
| agrt | No | integer | Specifies type of aggregation of the returned data. Aggregation type can be one of the following:
By default, data is aggregated by username and hostname. | ||||||||||||||||||||
| 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. Note: 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.
| ||||||||||||||||||||
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: fud | un | ugn | hn | hgn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb (See this section for more field-specific information.) If 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. |
Response
The following code block shows an example result of a successful request.Anchor response def response def
...
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters are as followsdescribed below.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${licenseServerId} | Yes | integer/string | ID of a single license server or "all" if information about all license servers is requested. |
| ${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, pdf. |
| sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-05-20. |
| ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-05-27. |
| grat | Yes | integer | Specifies granularity of the returned data, which can be one of the following:
|
| agrt | No | integer | Specifies aggregation type of the returned data. Aggregation type can be one of the following:
By default data is aggregated by username and hostname. |
| 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. (See this section for more format-specific information.) |
| fieldsVisibility | No | json/string | Specifies field visibility settings. (See the this section for more information.) 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: fud | un | ugn | hn | hgn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb (See this section for more field-specific information.) If 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. |
If your request is successful, you should see a response similar to the one presented above response given above for usage per user for a feature.