...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/feature/${returnType} |
There is also another, already deprecated, endpoint that you can use:
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/feature/${returnType} |
where the possible parameters are as follows:
| Parameter | Required | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | ||||||||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. | ||||||||||||||
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. 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 types. If provided, it cannot be left empty. | ||||||||||||||
| filter | No | json/string | Applies filtering to narrow down the results. To filter by a string column, use the following format:
To filter by a numeric column, use the following format:
| ||||||||||||||
| limit | No | integer | Specifies the number of records that must 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, lsid, lsn, vn, gtn. | ||||||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"fid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/feature/json" |
...
There is also another, already deprecated, endpoint that you can use:
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/feature/${returnType} |
...
| Code Block | ||
|---|---|---|
| ||
{ "fid": "1", "fv": "1", "ftype": "1", "lsn": "1", "vn": "1", "gtn": "1"} |
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.
...
Applies filtering to narrow down the results.
To filter by a string column, use the following format:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${fns | fv | ftype | lsn | vn | gtn}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
| Code Block | ||
|---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | lsid}",
"value": "${value}"
}
] |
...
Note: By default, filter rules are case-insensitive.
...