Versions Compared

Old Version 9

changes.mady.by.user Tracy McCurdy

Saved on

compared with

New Version 10

changes.mady.by.user Tracy McCurdy

Saved on

Key

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

...

ParameterRequiredTypeDescription
${lsid}YesintegerLicense Server ID.
${lsgid}YesintegerLicense Server Group ID.
${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: jsonJSON, CSV, csvXLSX, xls or pdfPDF.
fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{
  "fid": "1",
  "fns": "1",
  "fv": "1",
  "ftype": "1",
  "fu": "1",
  "fbrwd": "1",
  "frvd": "1",
  "ft": "1",
  "futil": "1",
  "fexp": "1",
  "flu": "1"
}

where "1" indicates that a specific field is visible and ''0" indicates 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.

rn

NostringSpecifies the name of the report that will be displayed once the report has been exported to PDF or XLSXLSX. 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 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
languagejs
firstline1
linenumberstrue
[
	{ 
		"type": "string",
		"field": "${ fns | fv | ftype | fexp | flu }",
		"value": "${value}"
	}
]

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

 

Code Block
languagejs
firstline1
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${ fu | fbrwd | frvd | ft | futil}",
        "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, fu, fbrwd, frvd, ft, futil, fexp, flu

(See this section for more field-specific information.)

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

...

The following example shows a command that downloads data about current usage for license server "7" in XLS XLSX format.

Code Block
linenumberstrue
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/7/current-usage/xlsxlsx"

Example 2

The following example shows a command that obtains information about features with current usage higher than 90% for license server "13."

...