Common API Parameters

• Blob Stores tags as binary large objects. The Blob datatype generally refers to undetermined binary data types, such as an Excel spreadsheet, a PDF file, or a Word file.
• Boolean (one byte) Stores boolean values. Valid values for the boolean data type are 0=FALSE and 1=TRUE. If the user sends zero, the value is taken as zero. Anything other than zero, the value is treated as one.
• Byte (one byte) Stores integer values. Valid values for the byte data type are -128 to +127.
• SingleFloat (four bytes) Stores decimal values up to six places. Valid ranges for the single float data type are 1.175494351e-38F to 3.402823466e+38F
• DoubleFloat (eight bytes) Stores decimal values up to 15 places. Valid values for the double float data type are 2.2250738585072014e-308 to 1.7976931348623158e+308.
• SingleInteger (two bytes) Stores whole numbers, without decimal places. Valid values for the single integer data type are -32767 to +32767.
• DoubleInteger (four bytes) Stores whole numbers, without decimal places. Valid values for the double integer data type are -2147483648 to +2147483648.
• FixedString (Configured by user) Stores string data of a fixed size. Valid values are between 0 and 255 bytes.
• Float Single float.
• Integer Single integer.
• MultiField Stores string data that has multiple words.
• QuadInteger (eight bytes) Stores whole numbers without decimal places. Valid values for the quad integer data type are -9,223,372,036,854,775,808 (negative nine quintillion) to +9,223,372,036,854,775,807 (positive nine quintillion).
• Scaled (two bytes) Lets you store a four-byte float as a twobyte integer in the Historian archive. The scaled data type saves disk space but sacrifices data precision as a result.
• Time Returns or sets the type of time stamping applied to data at collection time.
• UDoubleInteger (Unsigned Double Integer) (four bytes) Stores whole numbers without decimal places. Valid values for the unsigned double integer data type are 0 to 4,294,967, 295 (4.2 billion).
• Undefined Data type is not defined.
• UQuadInteger (Unsigned Quad Integer) (eight bytes) Stores whole numbers without decimal places. Valid values for the unsigned quad integer data type are 0 to 18,446,744,073,709,551,615 (19 quintillion).
• USingleInteger (Unsigned Single Integer) (two bytes) Stores whole numbers without decimal places. Valid values for the unsigned single integer data type are 0 to 65535.
• VariableString (No fixed size) Stores string values of undetermined size. This data type is useful if you cannot rely on a constant string length from your data source.
• Array Returns an array of tags from your data source. You can specify orientation, size, and number of rows returned in the array.

See Error Code Definition for more information.

JavaScript code can parse the value string as a JSON object. All field values are string.

(Enumerated value of DataQuality.StatusType)

Value and Status

• 0 Bad
• 1 Uncertain
• 2 NA
• 3 Good

• 1 true
• 0 false

This sampling mode is used with the time range and filter tag conditions. The response string starts with a starting time stamp and ends with an ending timestamp.

Use rate totals when working with a continuous measurement. Time weighting takes into account that compressed data is not evenly spaced in time. A factor must be applied to the total value to convert into appropriate engineering units. As a rate total, the default is Units/Day. If the actual units of the continuous measurement are Units/Minute, you would multiply the results by 1440 (minutes per day) to convert the total into appropriate engineering units.

Value is the count of raw samples with good quality in the interval. The values of each sample are ignored. The Count does not include any samples of bad quality, including the start and end of collection markers.

For Quality, the percentage of good samples is always 100, even if the interval does not contain any raw samples, or contains only bad quality samples.

Count is useful for analyzing the distribution of the raw data samples to determine the effect of compression deadbands. It is also useful to determine which tags are consuming the most archive space.

Value is the sum of all good quality samples in the interval, divided by the number of good quality samples in the interval. All bad quality samples are ignored. That is RawAverage is equivalent to RawTotal divided by the Count.

For Quality, if there are no raw samples in the interval or if they all are bad quality, then the percentage of good is 0. Otherwise, the percentage of good is always 100, even if the interval contains bad quality samples.

RawAverage is useful for calculating an accurate average when a sufficient number of raw samples are collected.

For Value, any raw point of bad data quality is ignored.

For Quality, if there are no raw samples in the interval or they all have bad quality, then the percentage of good is 0. Otherwise, the percentage of good is always 100, even if the interval contains bad quality samples.

RawStandardDeviation is useful for calculating an accurate standard deviation when a sufficient number of raw samples are collected.

Value is the sum of the good quality values of all raw samples in the interval. All bad quality samples are ignored.

For Quality, the percentage of good samples is always 100, even if the interval does not contain any raw samples or it contains only bad quality samples.

If the same start and end times are used, and the time span is treated as a single interval, then all values are added together.

RawTotal is useful for calculating an accurate total when a sufficient number of raw samples are collected. Note that unlike ihTotal, this is a simple sum with no assumption that the values are rate values.

Note that OPC Quality is a subfield for Quality-Value-Timestamp (QVT), so when this calculation mode is used, OPC Quality is considered for calculation.

Note that OPC Quality is a subfield for Quality-Value-Timestamp (QVT), so when this calculation mode is used, OPC Quality is considered for calculation.

Value is the value of the raw sample, or zero if there are no good raw samples in the interval.

For Quality, if there are not good raw samples in the interval, then the percentage of good is 0. Otherwise, the percentage of good is always 100, even if the interval contains bad quality samples. Note that Quality is the same for FirstRawValue and FirstRawTime.

The Raw sample has a quality of Good, Bad, or Uncertain, and that is converted to a 0 or 100 percent.

Value is the timestamp of the sample or the year 1969 if there are no good raw samples in the interval.

For Quality, if there are not good raw samples in the interval, then the percentage of good is 0. Otherwise, the percentage of good is always 100, even if the interval contains bad quality samples. Note that Quality is the same for FirstRawValue and FirstRawTime.

The Raw sample has a quality of Good, Bad, or Uncertain, and that is converted to a 0 or 100 percent.

Value is the value of the raw sample or zero if there are no good raw samples in the interval.

For Quality, if there are no good raw samples in the interval, the percentage of good samples is 0. Otherwise, the percentage of good is always 100, even if the interval contains bad samples. Note that Quality is the same for LastRawValue and LastRawTime.

The Raw sample has a quality of Good, Bad, or Uncertain, and that is converted to a 0 or 100 percent.

Value is the timestamp of the sample or the year 1969 if there are no good raw samples in the interval.

For Quality, if there are no good raw samples in the interval, the percentage of good samples is 0. Otherwise, the percentage of good is always 100, even if the interval contains bad samples. Note that Quality is the same for LastRawValue and LastRawTime.

The Raw sample has a quality of Good, Bad, or Uncertain, and that is converted to a 0 or 100 percent.

• Good (3)
• Not Available (2)
• Uncertain (1)
• Bad (0)

Interpolated and Lab Retrieval express quality as "percent good".

{
ihDataTypeUndefined = 0,
ihScaled,
ihFloat,
ihDoubleFloat,
ihInteger,
ihDoubleInteger,
ihFixedString,
ihVariableString,
ihBlob,
ihTime,
ihInt64,
ihUInt64,
ihUInt32,
ihUInt16,
ihByte,
ihBool,
ihMultiField,
ihArray,
ihMaxDataType
} ihDataType;

{
ihUnsolicited = 1,
ihPolled
} ihCollectionType;

{
ihSource = 1,
ihInterface,
} ihTimeStampType;

{
ihInterfaceUndefined = 0,
ihIFix,
ihRandom,
ihOPC,
ihFile,
ihIFixLabData,
ihManualEntry,
ihOther,
ihCalcEngine,
ihServerToServer,
ihPI,
ihOPCAE,
ihCIMPE,
ihPIDistributor,
ihCIMME,
ihPerfTag,
ihCustom,
ihServerToServerDistributor,
ihWindowsPerfMon,
} ihInterfaceType;

{
ihSeconds = 0,
ihMilliseconds,
ihMicroseconds,
ihNanoseconds
} ihTimeResolution;

{
ihConditionComparisonUndefined = 0,
ihConditionComparisonEqual,
ihConditionComparisonLessThan,
ihConditionComparisonLessThanEqual,
ihConditionComparisonGreaterThan,
ihConditionComparisonGreaterThanEqual,
ihConditionComparisonNotEqual
} ihConditionCollectionComparison;

{
ihDataDensityUndefined = 0,
ihDataDensityMinimum = 1,
ihDataDensityMedium = 4,
ihDataDensityMaximum = 7
} ihTagDataDensity;

{
ihRawTag = 0,
ihAnalyticTag = 1,
ihPythonExprTag = 2
} ihTagCalcType;