Versions Compared

Old Version 7

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

Saved on

compared with

New Version 8

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

Saved on

Key

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

...

ParameterRequiredTypeDescription
licenseServerIdYesarrayArrays of feature IDs in the following format: id1, id2, id3... for example fi=1,2,3,5.
sdNostringSpecifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. If not provided defaults to today.
edNostringSpecifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. If not provided defaults to [today + 12 months]
granularityNointegerSpecifies granularity of the returned data, and can be one of the following:
  • Quarter - 2
  • Month - 3
  • Week - 4
  • Day - 5

By default, this parameter is set to "Month"show monthly usage.

filterNostring

Applies filtering license usage data on all fields.

To filter by string column, use the following format: 

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

To filter by numeric column, use the following format:

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

...

FieldTypeDescription
successbooleanIndicates that your API request was successfully processed.
msgstringError message returned on failure.
fexpyintegerYear for which the period number has been specified.
fexpminteger

Number of time period such as day, week, month, etc.

fexpcintegerCount of features expiring features in the given period of time.
granularityinteger

Period granularity: 

  • QUARTER
  • MONTH
  • WEEK
    • DAY    		Specifies granularity of the returned data, and can be one of the following:
    • Quarter - 2
    • Month - 3
    • Week - 4
    • Day - 5
    By default, this parameter is set to show monthly usage.
    codeinteger

    Error code if success equals false, null otherwise.

    totalCountintegerTotal number of rows returned.

     

    Example 1

    For example, say If you would like to get obtain count of features that expire every month in the next 12 months on all your servers. To generate such data, enter a command that is similar to the following:

    Code Block
    languagebash
    curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/count/grouped/json"


    Example 2

    For example, say Say you would like to get obtain count of features that expire every week in some period of time on server with id ID 1. To generate such data, enter a command that is similar to the following: 

    Code Block
    languagebash
    curl --data "sd=2015-01-01" --data "ed=2015-03-01" --data "granularity=4" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/count/grouped/json"

    ...