Versions Compared

Old Version 6

changes.mady.by.user Tracy McCurdy

Saved on

compared with

New Version 7

changes.mady.by.user Tracy McCurdy

Saved on

Key

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

...

ParameterRequiredTypeDescription
${featureId}Yesinteger

Specifies ID of the feature for which you want to view utilization history.

${returnType}YesstringSpecifies the format in which the data should be returned. The format can be one of the following: JSONjson, CSVcsv, XLSXxlsx, or PDFpdf.
sdYesstringSpecifies the starting date from which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20.
ed

Yes

stringSpecifies the end date from which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20. The date is inclusive, meaning that all data from a particular day will be included in the report.
stYesstringSpecifies the start time of the time window that be applied for each date in a range ("working hours") in HH:MM format; for example, 09:30.
etYesstringSpecifies the end time of the time window that be applied for each date in a range ("working hours") in HH:MM format; for example, 09:30.
incdNobooleanSpecifies how utilization value should be calculated, i.e. whether the downtime periods should be included. If true, the length of the entire range will be used as a denominator ((days between ${sd} and ${ed} inclusively)*(et-st)). Otherwise only uptime periods will be used. Defaults to false.
fieldsVisibility Nojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{"lc": "1", "lhu": "1", "lutil": "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 numeric column, use the following format. 

Code Block
languagejs
firstline1
[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${lc | lhu | lutil}",
		"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:

 ls, lhu, lutil

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

...