Events

Description

Retrieves information about events and alarms.

Note: All property names are case-sensitive. Event storage preserves the case that you provide for any property value. For example, a property value of "TRUE" is different than "True" and "true."

URL

/Events

Method

GET 

Optional Parameters

• ID=[GUID]
  Globally unique identifier for the event.

• EventTime=[DateTime]
  UTC timestamp indicating when the event occurred.

• Type=[String]
  Main categorization of the event. Examples of valid values:
  - Alarm.Acknowledge - Application.Write
  - Alarm.Clear - User.Write
  - Alarm.Set - User.Write.Secured
  - Alarm.Write - User.Write.Verified

• Priority=[Int32]
  Value indicating the importance of the event. Values range from 1 to 999, with lower numbers indicating higher importance.

• Namespace =[String]
  The namespace for this event tag.

• Severity=[Int32]
  Categorization of the urgency of the event:
  1 - Critical
  2 - Major
  3 - Minor
  4 - Informational

• EventTimeUTCOffsetMins=[Int32]
  For local time, the offset in minutes from UTC time.

• ReceivedTime=[DateTime]
  UTC timestamp indicating when the event was received by the Historian server.

• IsAlarm=[Bool]
  "true" or "false" indicating whether this event is an alarm.

• Comment=[String]
  A comment providing more information about the event.

  Note: If an alarm comment from Application Server contains a backslash (for example, \n), then an extra backslash appears in the event result (for example, \\n) in the browser.

Optional Parameters

• InTouchType=[String]
  InTouch Type value. Examples include:
  - ALM
  - RTN
  - ACK
  - SYS

• ValueString=[String]
  The current value string.

• PreviousValueString=[String]
  The previous value string.

Optional Alarm Parameters

• Alarm_ID=[String]
  ID of the original Alarm event. For "Alarm.Set" events, this will be the same as the event ID.

• Alarm_Class=[String]
  InTouch alarm classification. Examples include "DSC" (discrete), "VALUE" (LoLo, Hi, etc.), "DEV" (deviation), and "ROC" (rate of change).

• Alarm_Type=[String]
  InTouch alarm type.

• Alarm_InAlarm=[Boolean]
  "true" or "false" indicating whether the Alarm is still in the active state.

• Alarm_Acknowledged=[Boolean]
  "true" or "false" indicating whether the user has acknowledged this alarm.

• Alarm_Condition=[String]
  The condition being alarmed. Examples include "Limit.Hi", "ROC.Lo", and "System" among others.

• Alarm_ValueString=[String]
  Value logged for the variable related to the event.

• Alarm_LimitString=[String]
  Limit being alarmed.

• Alarm_UnAckDuration=[Int32]
  The duration, in milliseconds, for which the alarm went un-acknowledged.

• Alarm_Duration=[Int32]
  The duration, in milliseconds, for which the alarm was active.

• Alarm_IsSilenced=[Boolean]
  "true" or "false" indicating whether the alarm was silenced.

• Alarm_IsShelved=[Boolean]
  "true" or "false" indicating whether the alarm was shelved.

• Alarm_ShelveStartTimeUTC=[DateTime]
  Scheduled start of the shelve time if the alarm has been shelved.

• Alarm_ShelveEndTimeUTC=[DateTime]
  Scheduled end of the shelve time if the alarm has been shelved.

• Alarm_ShelveReason=[String]
  The reason the alarm was shelved.

• Alarm_ShelveUserLogin=[String]
  The login ID for the person who shelved the alarm.

• Alarm_ShelveNode=[String]
  The node of the shelved alarm.

Optional Provider Parameters

• Provider_NodeName=[String]
  Name of the node that generated the event.

• Provider_System=[String]
  Software system that generated the event. Examples include "Application Server", "InTouch", and "InBatch".

• Provider_ApplicationName=[String]
  Application that generated the event. For Application Server, this will be the galaxy name. For InTouch, it will be the InTouch application name.

• Provider_SystemVersion=[String]
  Software version (for example, 4566.1210.5811.1) for the component identified by Provider_ApplicationName.

• Provider_InstanceNames=[String]
  Provider-specific string that uniquely identifies the instance an application on a given node.

Optional Source Parameters

• Source_Name=[String]
  The name of the data source for this event tag.

• Source_ProcessVariable=[String]
  Process variable to which the event is related.

• Source_ProcessVariable_Units=[String]
  Engineering units used for the process variable.

• Source_ConditionVariable=[String]
  Condition variable related to the event. For example, if "TIC101" has a field attribute "PV" and this is a "Hi" alarm, this value will be "TIC101.PV.Hi".

• Source_Object=[String]
  Non-hierarchical name for the object to which the event is related, for example, "TIC101".

• Source_HierarchicalObject=[String]
  Hierarchical name for the source object. For example, "Reactor_001.TIC".

• Source_Area=[String]
  Non-hierarchical Area name. For example, "Bottling_Zone".

• Source_HierarchicalArea=[String]
  Hierarchical Area name. For example, "Plant_001.Building_002.Mixing".

• Source_Engine=[String]
  Non-hierarchical engine name. For example, "AppEngine_001".

• Source_Platform=[String]
  Non-hierarchical platform name. For example "WinPlatform_001".

Optional User Parameters

• User_Account=[String]
  This is the login name for the operator for the given application.

• User_Name=[String]
  Name of the user.

• User_NodeName=[String]
  Computer name from which a user action was executed.

• User_Email=[String]
  The user's email address.

• User_Phone=[String]
  The user's phone number.

• User_InstanceName=[String]
  An instance name for the user.

• User_Agent=[String]
  Application name that the user was running when the event was generated.

Optional Verifier Parameters

• Verifier_Account=[String]
  This is the login name for theverifier.

• Verifier_Name=[String]
  Name of the verifier.

• Verifier_NodeName=[String]
  Computer name from which a verifier action was executed.

Sample Queries

https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/Historian/v2/Events
?$filter=EventTime+gt+'2017-07-13T00:00:00'

https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/Historian/v2/Events
?$filter=type+eq+'Alarm.Clear'

Sample Output

{

@odata.context: "https://online.wonderware.[DOMAINSUFFIX]/s/ik97r5/apis/Historian/v2/Events
/$metadata#Events",

value: [

{

id: "ee9b042c-181e-4872-b4e8-cb9575c1f4f9",

eventtime: "2017-07-13T00:00:01.047Z",

type: "Alarm.Clear",

receivedtime: "2017-07-13T00:00:01.2553666Z",

source_name: "AaEvents",

namespace: "AaEvents",

alarm_acknowledged: false,

alarm_class: "VALUE",

alarm_condition: "Limit.LoLo",

alarm_durationms: 5006,

alarm_id: "f1e21e43-352e-d3db-7552-6e77f193d02d",

alarm_inalarm: false,

alarm_isshelved: false,

alarm_issilenced: false,

alarm_limitstring: "10.0",

alarm_originationtime: "2017-07-12T23:59:56.041Z",

alarm_state: "UNACK_RTN",

alarm_tagtype: "S",

alarm_type: "LoLo",

comment: "Severity 1",

eventtimeutcoffsetmins: -420,

intouchtype: "LoLo",

isalarm: true,

priority: 1,

provider_applicationname: "AlarmsandEvents",

provider_nodename: "INSIGHTCHARTAPP",

provider_system: "Application Server",

provider_systemversion: "4966.1210.14578.2",

severity: 1,

source_area: "Plant_Area",

source_conditionvariable: "Drum_Conveyor.HorizontalMovement.LoLo",

source_hierarchicalarea: "Enterprise.Site.Plant.Plant_Area",

source_hierarchicalobject: "Drum_Conveyor",

source_object: "Drum_Conveyor",

source_processvariable: "Drum_Conveyor.HorizontalMovement",

valuestring: "30.0"

},