Payload Parameter

This parameter queries for the tag properties requested from the server.

Use the Payload parameter to query for all the tag properties to return from the server. In the Update Tag Configuration API, you must provide the actual tag property value. However, in the Get Tag Properties API, you must provide the property name and value of 1 (true), so the property can be read from the server and returned.

The properties listed in the following table are valid in APIs that use the Payload parameter, unless otherwise specified. For Property Names used in the Get Tag Properties API, the property name is always a Boolean (true/false) value, while it can be a string or integer for other APIs.

Property NameProperty TypeDescription
AllFieldsBooleanUsed for Get Tag Properties API.
NameBoolean, StringUsed for the Get Tag Properties API, Add Single Tag API, and Add Bulk Tags API.
DescriptionString
EngineeringUnitsString
CommentString
DataType : ihDataTypeSignedIntegralType definition is an enumerated type "ihDataType".
{
ihDataTypeUndefined = 0,
ihScaled,
ihFloat,
ihDoubleFloat,
ihInteger,
ihDoubleInteger,
ihFixedString,
ihVariableString,
ihBlob,
ihTime,
ihInt64,
ihUInt64,
ihUInt32,
ihUInt16,
ihByte,
ihBool,
ihMultiField,
ihArray,
ihMaxDataType
} ihDataType;
FixedStringLengthUnsignedChar
CollectorNameString
SourceAddressString
CollectionType : ihCollectionTypeSignedIntegralType definition is an enumerated type "ihCollectionType".
{
ihUnsolicited = 1,
ihPolled
} ihCollectionType;
CollectionIntervalSignedIntegral
CollectionOffsetUnsignedLong
LoadBalancingBoolean
TimeStampType : ihTimeStampTypeSignedIntegralType definition is an enumerated type "ihTimeStampType".
{
ihSource = 1,
ihInterface,
} ihTimeStampType;
HiEngineeringUnitsDouble
LoEngineeringUnitsDouble
InputScalingBoolean
HiScaleDouble
LoScaleDouble
CollectorCompressionBoolean
CollectorDeadbandPercentRangeFloat
ArchiveCompressionBoolean
ArchiveDeadbandPercentRangeFloat
General1String
General2String
General3String
General4String
General5String
ReadSecurityGroupString
WriteSecurityGroupString
AdministratorSecurityGroupString
LastModifiedBooleanUsed for Get Tag Properties API.
LastModifiedUserBooleanUsed for Get Tag Properties API.
InterfaceTypeBooleanUsed for Get Tag Properties API.
CollectorType : ihInterfaceTypeSignedIntegralType definition is an enumerated type "ihInterfaceType".
{
ihInterfaceUndefined = 0,
ihIFix,
ihRandom,
ihOPC,
ihFile,
ihIFixLabData,
ihManualEntry,
ihOther,
ihCalcEngine,
ihServerToServer,
ihPI,
ihOPCAE,
ihCIMPE,
ihPIDistributor,
ihCIMME,
ihPerfTag,
ihCustom,
ihServerToServerDistributor,
ihWindowsPerfMon,
} ihInterfaceType;
UTCBiasSignedIntegral
AverageCollectionTimeBooleanUsed for Get Tag Properties API.
CalculationDependenciesStringArray
CollectionDisabledBoolean
ArchiveCompressionTimeoutUnsignedLong
CollectorCompressionTimeoutUnsignedLong
SpikeLogicBoolean
SpikeLogicOverrideBoolean
CollectorAbsoluteDeadbandingBoolean
CollectorAbsoluteDeadbandDouble
ArchiveAbsoluteDeadbandingBoolean
ArchiveAbsoluteDeadbandDouble
StepValueBoolean
TimeResolution : ihTimeResolutionSignedIntegralType definition is an enumerated type "ihTimeResolution".
{
ihSeconds = 0,
ihMilliseconds,
ihMicroseconds,
ihNanoseconds
} ihTimeResolution;
ConditionCollectionEnabledBoolean
ConditionCollectionTriggerTagString
ConditionCollectionComparison : ihConditionCollectionComparisonSignedIntegralType definition is an enumerated type "ihConditionCollectionComparison".
{
ihConditionComparisonUndefined = 0,
ihConditionComparisonEqual,
ihConditionComparisonLessThan,
ihConditionComparisonLessThanEqual,
ihConditionComparisonGreaterThan,
ihConditionComparisonGreaterThanEqual,
ihConditionComparisonNotEqual
} ihConditionCollectionComparison;
ConditionCollectionCompareValueString
ConditionCollectionMarkersBoolean
CalculationStringWhen the Calculation field is used, then two more conditions are required. Calculation is not a specific field for a tag property. If the tag's collector or interface type is Server-to-server and the Calculation field is set (not Null), then the field value is set to the source address.
TagIdBooleanUsed for Get Tag Properties API.
EnumeratedSetNameString
DataStoreNameString
DefaultQueryModifiersLong Long
UserDefinedTypeNameString
NumberOfElementsSignedIntegral
DataDensity : ihTagDataDensitySignedIntegralType definition is an enumerated type "ihTagDataDensity".
{
ihDataDensityUndefined = 0,
ihDataDensityMinimum = 1,
ihDataDensityMedium = 4,
ihDataDensityMaximum = 7
} ihTagDataDensity;
CalcType : ihTagCalcTypeSignedIntegralType definition is an enumerated type "ihCalcType".
{
ihRawTag = 0,
ihAnalyticTag = 1,
ihPythonExprTag = 2
} ihTagCalcType;
HasAliasBooleanUsed for Get Tag Properties API.
IsStaleBooleanUsed for Get Tag Properties API.