Versions Compared

Old Version 23

changes.mady.by.user Tracy McCurdy

Saved on

compared with

New Version 24

changes.mady.by.user Tracy McCurdy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Obtaining information about usage above/below N hours (report Current Usage Above 24 HoursBy Time Range) 

You can easily list data about features currently in use for more/less than N hours by sending the following HTTP request

...

Parameter
Required
Type
Description
${returnType}YesstringSpecifies the format in which the data should be returned. The format can be one of the following: JSONjson, CSVcsv, XLSXxlsx, or PDFpdf.
abNointegerSpecifies 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.
blNointeger

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).

fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
linenumberstrue
{"fid": "1", "fns": "1", "fv": "1", "ftype":"1", "vn": "1", "lsid": "1", "lsn": "1", "uid": "1", "un": "1", "hn": "1", "lus": "1", "tu": "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.

rnNostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. 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 XLSX types. If provided, it cannot be left empty.
filterNojson/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format:

 

Code Block
linenumberstrue
[
    {
        "type": "string",
        "field": "${fns | fv | ftype | vn | lsn | un | hn}",
        "value": "${value}"
    }
]

To filter by a numeric column, use the following format: 

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${fid | lsid | uid | lus}",
        "value": "${value}"
    }
]


limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.
offsetNointegerSpecifies the offset of the first row to return.
orderByNostring

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.)

orderDirectionNostringDetermines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order.

...