Summary (v1 only)

Description

Retrieves summary data for a user-defined interval.

The additional query option "Resolution" is used to specify the interval to be used for this entity.

The earliest and latest requested values of StartDateTime and/or EndDateTime are used for determining the span of time covered by the summary intervals returned.

URL

/Summary

Method

GET 

Required Parameters

• FQN=[string]
  The fully qualified name for the tag. A fully qualified tagname uses the format: DataSourceName.TagName.

• StartDateTime=[DateTimeOffset]
  The starting date and time for the retrieval cycle. This is always specified in UTC using the RFC3339 / ISO8601 format with the Z time zone designator. For example: 2016-09-03T18:44:09.352247Z

• EndDateTime=[DateTimeOffset]
  The ending date and time for the retrieval cycle. This is always specified in UTC using the RFC3339 / ISO8601 format with the Z time zone designator. For example: 2016-09-03T18:44:09.352247Z

Optional Parameters

• OPCQuality=[Int32]
  OPC quality. Normal OPC quality retrieval logic is applied if:

  All the point found and processed for this row have GOOD quality. If they all have the same GOOD quality, then that quality is returned.

  If there is a gap in the entire calculation cycle, then BAD quality is returned for the tag.

  For any other scenario with any mixture of GOOD and BAD points, a DOUBTFUL OPC quality (64) is returned.

• PercentGood=[Double]
  The ratio of the number of rows that have "good" quality to the total number of rows in the retrieval cycle, expressed as a percentage in the range 0 to 100.

• Analog
  An embedded collection that maps to AnalogSummary.

• Split
  An embedded collection that maps to StateSummary for the ValueState retrieval mode.

• Contained
  An embedded collection that maps to StateSummary for the ContainedState retrieval mode.

• Raw
  A URL used to retrieve all stored values for a specified time period and tag. This is equivalent to a preconfigured ProcessValue query.