Tags

Description

Using the GET verb, retrieves tag metadata. For version 2, this also includes tag extended properties.

Using the POSTverb, manages multiple tags at once.

Using the DELETE verb, deletes a specified tag.

URL

/Tags

Methods

GET 

POST

DELETE

Required Parameters

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

Optional Parameters

• Source=[string ]
  The data source.

• Description=[string ]
  The description of the tag.

• EngUnit=[string]
  The engineering units used for the tag's recorded values.
  EngUnitMax=[Double]
  The maximum value of the tag, measured in engineering units.

• EngUnitMin=[Double]
  The minimum value of the tag, measured in engineering units.
  The minimum value of the tag, measured in engineering units.

• InterpolationType=[string]
  The interpolation type for retrieval. 0 = Stair-stepped interpolation; 1 = Linear interpolation (if applicable, based on the tag type); 254 = System default interpolation mode. The system default interpolation type is to use the system default for the analog type, either integer or real. The system default interpolation type for an analog type is determined by the setting of the InterpolationTypeInteger and InterpolationTypeReal system parameters. This setting impacts Interpolated, Average, and Integral retrieval modes.

• IntegralDivisor=[Double]
  The factor to be applied when integrating a rate with the units [EngUnits/TimeUnit] to a quantity with units [EngUnits]. This factor is called the integral divisor.

  The default value of 1 assumes a time unit of seconds and ensures that a rate of [Unit/second] is correctly integrated to [Unit].

  For a time unit of minutes, set the integral divisor value to 60; for a unit of hours, set the integral divisor value to 3600. The integral divisor is applied similarly to rates or quantities that are not expressed in terms of a time unit. For example, to convert watts to watt-hours, the integral divisor is 1/3600. To convert watts to kilowatt-hours, the integral divisor is 1/3600000. Internal use only.

Optional Parameters

• RolloverValue=[Double]
  The rollover value for the tag.

• MessageOff=[string ]
  The message associated with the FALSE state of the discrete tag. The maximum number of characters is 64. A discrete tag set to 0 is in the FALSE state.

• MessageOn=[string ]
  The message associated with the TRUE state of the discrete tag. The maximum number of characters is 64. A discrete tag set to 1 is in the TRUE state.

• TagName=[string ]
  The unique name of the tag within the AVEVA Historian system.

• TagType=[string ]
  The type of tag. 1 = Analog; 2 = Discrete; 3 = String; 5 = Event, 7 = Summary tag (analog or state). TagType is a foreign key from the AVEVA Historian TagRef table.

• Raw
  Identifies related the raw acquired value.

• Minutely
  Identifies related minutely summary.

• Hourly
  Identifies related hourly summary.

• Daily
  Identifies related daily summary.