Page History

License Statistics API lets you generate data from The Expiring Features endpoint delivers license usage metrics specific to  This the Expiring Features report.report shows statistics for features expiring in the futurethat are nearing expiration.

Obtaining information about expiring features

If you want to retrieve information about expiring features, we recommend that you use the following URL request template.

You can easily list features that are nearing expiration by sending the following HTTP request.

GET /api/v1/report/expiry/server/${licenseServerId}/json${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}$(additional parameters, as needed)

 where  - $ $ indicates a variable value that you can replace with an appropriate value, as needed - a value that best suits your needs. The possible parameters are as follows:described below.

[
	{ 
		"type": "string",
		"field": "${fns | ftype | fexp | lsn | vn | fv}",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${fid | lsid}",
		"value": "${value}" 
	}
]

{ 
	"fns": "1", 
	"fv": "1", 
	"ftype": "1", 
	"vn": "1", 
	"lsn": "1", 
	"fexp": "1"
}

fns | fv | ftype | vn | lsn | fexp

...

Response

On success, this report will contain one row for each feature expiring in the specified time range. Each row consists of the following columns.

Column	Full name	Type	Description	Visible by default in export
fid	Feature ID	integer	Internal License Statistics identification of the feature.	Yes
fns	Feature Name	string	Feature name.	Yes
fv	Feature Version	enumeration	Feature version.	Yes
ftype	Feature Type	string	See feature type descriptions for details.	Yes
vn	Vendor	string	Name of license server vendor hosting the feature.	Yes
lsid	License Server ID	integer	Internal License Statistics identification of license server hosting the feature.	Yes
lsn	License Server	string	Name of license server hosting the feature.	Yes
fexp	Feature Expires	date	Day when the feature expires.	Yes

Note that the order in the table is the default order of the columns in the exported file.

Example 1

The following example shows a command that obtains statistics about all features expiring in the next 12 months on all license servers. 

...

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{
      		"fid": ${featureId},
      		"fns": ${featureName},
      		"ftype": ${featureType},
      		"fv": ${featureVersion},
      		"fexp": ${featureExpires},
      		"lsid": ${licenseServerId},
      		"lsn": ${licenseServerName},
      		"vn": ${licenseServerVendorName},
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

where the response fields can be explained as follows:

...

Feature Name.

...

vn

...

Error code if success equals false, null otherwise.

...

Example 1

For example, say you would like to view all features expiring in next 12 months on all of you license servers. To generate such data, enter a command that is similar to the following:

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/json"

Example 2

For example, say you would like to view The following example shows a command that obtains information about all features expiring in some a specified period of time on one of your license servers that have licenseServerId=1. To generate such data, enter a command that is similar to the following:a license server with an ID of "1."

curl --data "sd=2015-01-01" --data "ed=2015-03-01" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/json"

Obtaining information about the number of features expiring features amounts in some period of timeIf you want to retrieve information about how many features expires in some period, we recommend that you use the following URL request template. 

You can easily list features that are going to expire in some period of time by sending the following HTTP request:

GET /api/v1/report/expiry/server/{licenseServerId}/count/grouped/json?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&granularity=${granularity}&filter=${filter}

Parameters are where the possible parameters can be explained as follows:

[
	{ 
		"type": "string",
		"field": "${fns | ftype | fexp | lsn | vn | fv}",
		"value": "${value}"
	}
]

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "${fid | lsid}",
		"value": "${value}" 
	}
]

...

This report supports only JSON format.

This report supports filtering, but does not support other standard options (limiting or ordering).

Response

On success, this report will contain one row for each feature expiring in the specified time range. Each row consists of the following columns.

...

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{
      		"fexpy": ${featureId},
      		"fexpm": ${featureName},
      		"fexpc": ${featureVersion},
      		"granularity": ${granularity}
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

...

Example 1

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

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

Example 2

For example, say you would like to get The following example shows a command that obtains a count of features that will expire for every week in some a specified period of time on a license server with id 1. To generate such data, enter a command that is similar to the following: an ID of "1."

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"

...