Versions Compared

Key

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

...

ParameterRequiredTypeDescription
${featureId}Yesinteger

Specifies feature-specific parameters.

${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: JSONjson, CSVcsv, XLSXxlsx, or PDFpdf.
sdtYesstringSpecifies point in time for which you want to generate the report. The date is in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00.
fieldsVisibility Nojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{"un": "1", "hn": "1", "sst": "1", "set": "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.
filterNojson/string

Applies filtering license usage data on all fields. To filter your data, use the following format.

Code Block
languagejs
firstline1
linenumberstrue
[{"value": intOrString, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}]


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:

uid, un, hn, sst, set

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

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

...

ParameterRequiredTypeDescription
${featureId}YesintegerSpecifies feature-specific parameters.
${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: JSONjson, CSVcsv, XLSXxlsx, or PDFpdf.
ssdYesstring

Specifies the start date for which the report will be generated The date is in YYYY-MM-DD format; for example, 2017-05-20.

sedYesstring

Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27.

fieldsVisibility  

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{"un": "1", "hn": "1", "sst": "1", "set": "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 Excel.
filterNojson/string

Applies filtering license usage data on all fields. To filter your data, use the following format.

Code Block
languagejs
firstline1
linenumberstrue
[{"value": intOrString, "field": "${un | hn | sst | set}"}]


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:

uid, un, hn, sst, set 

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

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

...