Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API Reference

DataServer GetLicense

DataServer GetLicense

Retrieves the specified license for the given Data Server. The fields of the response object are string representations of the numerical values reported by the Data Server, with "Infinity" representing a license field with no limit. See Data Server Licenses for more information.

Request

GET dataservers/{webId}/license

URL Parameters

  • webId

    The ID of the server. See WebID for more information.

  • module

    The case-sensitive name of the module.

  • selectedFields

    List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.

  • webIdType

    Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.

Status Codes

200: The specified license.

404: No license with the specified module name existed.

Sample Response Body

{
  "AmountLeft": "85675",
  "AmountUsed": "1325",
  "Name": "Component.Module",
  "TotalAmount": "10000",
  "Links": {}
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in