Versions Compared

Old Version 4

changes.mady.by.user Unknown User (mkos)

Saved on

compared with

New Version 5

changes.mady.by.user Unknown User (mkos)

Saved on

Key

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

...

Parameter
Required
Type
Description
${licenseServerId}Yesinteger/stringSpecifies ID of license server for which we want to gather data about features nearing expirationcurrently borrowed licenses. You can set this parameter to 'all' to gather data from all license servers. 
${returnType}YesstringSpecifies the format in which the data should be returned. The format can be one of the following: json, csv, xls or pdf.
fieldsVisibility Nojson/string

Specifies field visibility settings, for example:

Code Block
linenumberstrue
{ "lsid": "1", "lsn": "1", "fid": "1", "fns": "1", "fv": "1", "ftype": "1", "lus": "1", "lco": "1", "lbe": "1", "uid": "1", "un": "1", "hn": "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 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.
filterNojson/string

Applies filtering license usage data on all fields.

To filter by string column, use the following format:

 

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

To filter by numeric column, use the following format: 

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${lsid | fid | lus | uid}",
        "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:

lsid, lsn, fid, fns, fv, ftype, lus, lco, lbe, uid, un, hn

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

...