Properties

FQN

string

The fully qualified name for the tag. A fully qualified name uses the format: datasource.tagname.

OPCQuality

Int32

Defines the OPC quality for the data.

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.

First

Double

If at least one non-NULL point exists for the tag in question within the retrieval cycle, then the value returned is the first point stored with a time stamp within the retrieval cycle. If no points exist within the retrieval cycle, then the value returned is the current value at the cycle start time. If no non-NULL points can be found, then NULL is returned.

FirstDateTime

DateTimeOffset

Timestamp associated with first value. This might be earlier than StartDateTime if this is the initial value for the retrieval cycle.

Last

Double

If at least one non-NULL point exists for the tag in question within the retrieval cycle, then the value returned is the last point stored with a time stamp within the retrieval cycle. If no points exist within the retrieval cycle, then the value returned is the current value at the cycle start time.

If no non-NULL points can be found, then NULL is returned.

LastDateTime

DateTimeOffset

Timestamp associated with last value. This might be earlier than StartDateTime if this is the initial value for the retrieval cycle.

Minimum

Double

If at least one non-NULL point exists for the tag in question within the retrieval cycle, then the value returned is the minimum point stored with a time stamp within the retrieval cycle. If no points exist within the retrieval cycle, then the value returned is the current value at the cycle start time. If no non-NULL points can be found, then NULL is returned.

MinDateTime

DateTimeOffset

Timestamp associated with Min value. NULL if Min is NULL.

Maximum

Double

If at least one non-NULL point exists for the tag in question within the retrieval cycle, then the value returned is the maximum point stored with a time stamp within the retrieval cycle. If no points exist within the retrieval cycle, then the value returned is the current value at the cycle start time.

If no non-NULL points can be found, then NULL is returned.

MaxDateTime

DateTimeOffset

Timestamp associated with Max value. NULL if Max is NULL.

Average

Double

Time weighted average value of retrieval cycle. This is calculated by using the individual summary averages. The calculation is "Sum(average * delta t) / Total time of average in all cycles" - delta t is prorated for any partially contained storage cycles. For analog tags, the calculation is "Sum(value * delta t) / Total time.

StdDev

Double

Time weighted standard deviation value of the retrieval cycle. The value is calculated using time weighted sums (Integrals) and time weighted sums of squares (IntegralOfSquares) values.

Integral

Double

Area under value curve of retrieval cycle. The calculation is "Sum(value * delta t) / Total time of integral in all cycles" - delta t is prorated for any partially contained storage cycles. For analog tags, the calculation is "Sum(value * delta t) / Total time.

Count

Double

Number of values in a particular cycle.

FQN

Fully qualified name.

DateTime

Value recorded date time.

OpcQuality

Tag quality.

Text

Text value of the tag.

Value

Value of the tag.

FQN

string

The fully qualified name for the tag. A fully qualified name uses the format: datasource.tagname.

TagName

string

The unique name of the tag within the AVEVA Historian system.

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.

MessageOff

string

The message associated with the FALSE state of the discrete tag.

MessageOn

string

The message associated with the TRUE state of the discrete tag.

TagType

string

The type of tag. 1 = Analog; 2 = Discrete; 3 = String; 5 = Event, 7 = Summary tag (analog or state)

Namespace

String

The equipment namespace.

Equipment

String

The equipment name.

StartTime

DateTime

The start time (in UTC format) of the context events.

PropertyName

String

The name of the property.

PropertyValue

String

The value of the property.

AutomationSource

String

This parameter is for internal use.

Name

String

The description of an equipment. Equipment are unique by Name combined with Namespace. Also by Name combined with Location

Namespace

String

The namespace of an equipment

Description

String

The description of an equipment

Location

String

The location of an equipment

Id

String

The unique Id of an equipment

_etag

String

This an optimistic concurrency tag which prevents overlapping updates to an entity

Name

String

An equipment state name. This is unique across all equipment states.

Description

String

An equipment state description.

Color

String

Represents an equipment state color in the RGB format (#DC0A0A).

StateType

Number

Represents an equipment state type (1=Idle, 2=Runtime, 3=Downtime).

DisableDate

DateTime

The disabled date. If this has a value, then the state is considered deleted.

Id

String

The unique Id for an entity.

_etag

String

This an optimistic concurrency tag which prevents overlapping updates to an entity.

ProducedTime

DateTime

The UTC time when the production was added. The default is the current time.

Equipment

String

The equipment name.

Namespace

String

The equipment namespace.

DispositionReason

String

The disposition reason or automation value for the production that is being added. The reason must exist in the efficiency model.

DispositionType

Int32

A read-only property, which is ignored if passed. It is set internally based on the DispositionReason.

Quantity

Double

The quantity of items that were produced. Quantity can be positive or negative value. A negative quantity results in reducing existing event quantities with the same disposition reason. Negative quantities also result in an Http 204 (No Content) being returned. However, an error is returned if the negative quantity is greater than the produced quantity for the active production run.

OriginalQuantity

Double

A read-only property, which is ignored if passed. If a production event is ever adjusted due to an Edit or Reclassify, this property holds the original value before it was adjusted. Typically for internal use only.

Comment

String

A comment about the production that is being added.

AutomationSource

String

This parameter is for internal use.

Id

String

The unique Id of an equipment.

LastModified

DateTime

The UTC time when the production was modified.

_etag

String

This an optimistic concurrency tag which prevents overlapping updates to an entity.

StartTime

DateTime

The start time of the utilization event.

Equipment

String

The equipment name.

Namespace

String

The equipment namespace.

Location

String

The equipment location.

StateType

Number

The equipment state type (1=Idle, 2=Runtime, 3=Downtime).

EquipmentState

String

The equipment state name.

UtilizationReason

String

The utilization reason name.

Comment

String

An event comment.

EndTime

DateTime

The end time of the utilization event.

AutomationSource

String

The Tag FQN when the utilization event is from data collection (Internal use).

Id

String

The unique Id for an entity.

_etag

String

This an optimistic concurrency tag which prevents overlapping updates to an entity.