Summary Type (Core Services)
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
Values to indicate which summary type calculation(s) should be performed. The following values are accepted:
-
Total A totalization over the time range.
-
Average The average value over the time range.
-
Minimum The minimum value over the time range.
-
Maximum The maximum value over the time range.
-
Range The range value over the time range (minimum-maximum).
-
StdDev The standard deviation over the time range.
-
PopulationStdDev The population standard deviation over the time range.
-
Count The sum of event count over the time range when calculation basis is event weighted. The sum of event time duration over the time range when calculation basis is time weighted.
-
PercentGood Percent of data with good value during the calculation period. For time weighted calculations, the percentage is based on time. For event weighted calculations, the percent is based on event count.
-
TotalWithUOM A totalization over the time range with UOM assigned to the result if the input has units of measure defined. If the input does not have units of measure defined, this returns the same value as Total. If no valid units can be determined, this value will contain an error.
-
All A convenience for requesting all available summary calculations.
-
AllForNonNumeric A convenience for requesting all available summary calculations for non-numeric data.