Service: Event

Creating, reading and operation Events and accessing the events archive

Functions

Result	Name / Params			Comment
GetResult	event.Get			Returns a filtered list of Event Objects.
		filter	string	(Optional) Filter expression which determines the result set.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
GetResult	event.Get			Returns a filtered list of Event Objects.
		scroll	int	Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
Event	event.GetOne			Returns a single Event Object identified by the given id.
		id	guid	The Event's id.
		select	string[]	(Optional) List of properties that should be contained in the result object.
GetResult	event.GetFromArchive			Returns a filtered list of Event Objects from the archive.
		filter	string	(Optional) Filter expression which determines the result set.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
GetResult	event.GetFromArchive			Returns a filtered list of Event Objects from the archive.
		scroll	int	Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned.
Event	event.GetOneFromArchive			Returns a single Event Object identified by the given id from the archive.
		id	guid	The Event's id.
		select	string[]	(Optional) List of properties that should be contained in the result Object.
guid	event.Create			Creates an event.
		segmentId	guid	(Optional)
		type	int	Only one logical value should be set for type. See EnumStateFlags.
		category	string	(Optional)
		name	string	(Optional)
		desc	string	(Optional)
		prio	int	(Optional)
		tags	string	(Optional)
		location	string	(Optional)
		geoPos	GeoPosition	(Optional)
		beginTime	time	(Optional)
		utcOffset	int	(Optional)
		text	string	(Optional)
		graphics	string[#]	(Optional)
		textMacros	string[#]	(Optional)
		datapointId	guid	(Optional) From this Datapoint other missing props will be set.
		locationId	guid	(Optional) From this location other missing props will be set.
		activityId	guid	(Optional)
		incident	Incident	(Optional)
		stateType	int	(Optional) Only one logical value should be set for type. See EnumStateFlags.
		stateText	string	(Optional)
		startValue	string	(Optional)
		functionality	string	(Optional)
		animationScheme	string	(Optional)
		cameras	guid[]	(Optional)
		extRef	string	(Optional)
		extSource	string	(Optional)
		props	value{}	(Optional)
		processing	int	(Optional) See EnumEventProcessingFlags.
bool	event.Set			Sets specific properties of an Event Object. Only for non archived Events.
		id	guid	Id of the Event to modify.
		props	value{}	List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	event.Accept			Accepts an Event.
		id	guid	Id of the Event to accept.
		forceAutoComplete	bool
bool	event.Complete			Completes an Event.
		id	guid	Id of the Event to complete.
		forceComplete	bool
bool	event.End			Ends an Event.
		id	guid	Id of the Event to end.
		time	time	Time to set as the end time.
bool	event.Assign			Assigns the Event with to a given station.
		id	guid	Id of the Event.
		station	int	Station num.
int	event.AddAttachment			Adds an attachment to an Event. Only works for accepted Events.
		id	guid	Id of the Event to add the attachment to.
		type	string	Type of the attachment. See EnumAttachmentType.
		mimeType	string	The attachment's mime type.
		name	string	Display name to use for the attachment.
		time	time	Associates a creation date.
		data	data	Binary data of the attachment.
		inReport ≥wg 0.4.17	bool	(Optional) States if the attachment should be part of a report.
bool	event.RemoveAttachment			Removes an attachment from an Event.
		id	guid	Id of the Event to remove the the attachment from.
		attachmentId	int	Id of the attachment to remove.
int	event.AddNote			Adds a note attachment to an Event. Only works for accepted Events.
		id	guid	Id of the Event to add the note to.
		text	string	The note's text.
bool	event.EditNote			Edits a note attachment of an Event.
		id	guid	Id of the Event to edit the note of.
		attachmentId	int	Id of the attachment to edit. This has to be a note attachment or this function will fail.
		text	string	The note's updated text. This will replace all previously set text.
bool	event.RemoveNote			Removes a note attachment from an Event.
		id	guid	Id of the Event to remove the note attachment from.
		attachmentId	int	Id of the attachment to remove. This has to be a note attachment or this function will fail.
int	event.AddContext			Adds a user defined context to an Event.
		id	guid	Id of the Event to add the context to.
		context	EventContext	Context to add.
bool	event.EditContext			Edits a user defined context of an Event.
		id	guid	Id of the Event to edit the context for.
		contextId	int	Id of the context to edit.
		context	EventContext	Context to set.
bool	event.Fetch ≥wg 0.4.10			Fetch the Event with the given id.
bool		id	guid	The Event's id.
bool	event.Reset ≥wg 0.4.10			Send a reset command directly to the Extension, which is responsible for the given Event. This requires the Extension to support the command.
		id	guid	The Event's id.
		all	bool	Indicates if all open Events of the responsible Extension should be reset or just the referenced Event.
bool	event.Defer ≥wg 0.4.10			Send the selected event to the deferred events area or retrieve it from there.
bool		id	guid	The Event's id.

Notifications

Name / Params			Comment
event.Created			Notifies newly created Events.
	objects	Event[]	Newly created Events.
event.Updated			Notifies updated Events.
	objects	Event[]	Updated Events.
event.Deleted			Notifies deleted Events.
	ids	guid[]	Ids of the deleted Events.

Objects

Event

Property	Type	Description
Id	guid	(Unique, Readonly) Internal unique id of the Event Data Object.
SegmentId	guid	Assigned segment if appropriate.
HRId	string	(Unique, Readonly) Human readable Event id.
Type	int	See EnumStateFlags.
Category	string	The category ot the Event, usually taken from the triggering Object.
Name	string	(Localized) The name of the triggering Datapoint at the time the Event was created.
Desc	string	(Localized) The description of the triggering Datapoint at the time the Event was created.
Prio	int	Priority of the Event. -1 means Event is not displayed.
Tags	string	Tags enclosed in vertical bars (pipes), such as “\|tag1\|tag2\|tag3\|”.
Location	string	Full name of the location.
GeoPos	GeoPosition	Geographical coordinates.
ProcessingFlags	int	See EnumEventProcessingFlags.
Notes	string	Current notes from Datapoint
NotifiedStations ≥wg 0.4.15	string[]	List of station IDs that should receive a notification for this event.
BeginTime	time	(Readonly) Time of Event occurrence.
AcceptTime	time	(Readonly) Time when Event has been accepted by the user.
CompletionTime	time	(Readonly) Time when Event was completed by the user.
EndTime	time	(Readonly) Time when the reason for the Event disappeared.
LastOperationTime	time	(Readonly) Time of the last user operation at the Event (accept, defer / un-defer, station assignment).
UtcOffset	int	(Readonly)
CurrentStation	int	(Readonly) Current station number where Event is assigned too.
AcceptUser	string	(Readonly) Code of the user, who has accepted the Event.
CompletionUser	string	(Readonly) Code of the user, who has completed the Event.
State	int	(Readonly) See EnumEventStateFlags.
Text	string	Text (workflow) document, filename with display params.
Graphics	string[#]	Graphic documents, always filename with display params.
TextMacros	string[#]	String snippets which can be used as variables. Can also contain a text file name.
TextInputs	TextInput[]	Collects the user input from the workflow. The content of the named controls is put here.
Attachments	Attachment[#]	List with description of the attachments.
Resources	Resource{}	Resources, the resource id is used as a key to the map.
ExtRef	string
ExtSource	string	State or Event from SST.
Contexts	EventContext[#]	Externally set EventContexts.
DatapointId	guid	If appropriate, the id of the triggering Datapoint.
LocationId	guid	If appropriate, the location id of the triggering Object.
Incident	Incident	Externally managed Incident if assigned.
Link	Link	Associated external object. If a Datapoint id is set the link object matches the one inside the Datapoint.
DeviceType	string	If appropriate, the device type of the triggering Object.
DatapointType	int	If appropriate, the Datapoint type of the triggering Object. See EnumDatapointType.
SensorNum	int	If appropriate, the sensor number of the triggering Object.
SensorCount	int	If appropriate, the number of sensors in the sensor group of the triggering Object.
StateType	int	State type that was set when the Event was created. Used for reference only. See EnumStateFlags.
StateText	string	Additional text for the state, if appropriate.
StateValue	int	Value for legacy SST support.
Functionality	string
StartValue	string	If appropriate, the transcribed value of the triggering Object at start of the Event.
EndValue	string	If appropriate, the transcribed value of the triggering Object at the end of the Event.
Cameras	guid[]
AnimationScheme	string
Props	value{}	Collects varying props dependent from and provided by the Event source.
GroupId	guid	(Readonly) Id of the group parent, if the Event is part of a group. For the group parent itself is true: GroupId == Id.
GroupHRId	string	(Readonly) HRId of the group parent.
GroupCount	int	(Readonly) Number of Events in the group, including the group parent.

EventContext

Property	Type	Description
Time	time
Name	string
GeoPos	GeoPosition
Text	string
Graphics	string[#]
TextMacros	string[#]
LocationId	guid
Location ≥wg 0.4.2	string
Incident	Incident
StartValue	string
EndValue	string
Props	value{}
States	DatapointState[]

DatapointState

Property	Type	Description
Id	guid	Datapoint id, this is only set inside notifications.
Flags	int	The current State of the Datapoint. The different States are flags in a short value See EnumStateFlags.
Text	string	Additional text information. Not all States have an additional text.
Value	float	Additional value information. Not all States have an additional value.
Time	time	Additional time information. Not all States have an additional value.
GeoPos	GeoPosition	Additional geographical coordinates. Not all States have a geo position.
Ptz	PtzInfo	(Optional) Additional information about pan angle, tilt angle and zoom value of a PTZ-capable camera. Not all States have a PTZ info.
COPs ≥wg 0.4.11	guid[]	Ids of control operations (COPs) that are currently active for this Datapoint.
COPFlags ≥wg 0.4.11	int	The Datapoint states (as flags) that were set by control operations. See EnumStateFlags.
Props	value{}	Additional properties.

TextInput

Property	Type	Description
Context	string
Value	string

Attachment

Property	Type	Description
Url	string	Links to an Object or the attachment’s data itself depending on the mime type.
MimeType	string
Type	string	See EnumAttachmentType.
Name	string	(Localized)
Desc	string	(Localized)
EditTime	time
InReport ≥wg 0.4.17	bool	States if the attachment should be part of a report.

Link

Property	Type	Description
Url	string
Ext	string
ObjId	string
ObjType	string
Props	value{}

GeoPosition

Property	Type	Description
Latitude	float	(DistinctNull)
Longitude	float	(DistinctNull)
Altitude	float	(DistinctNull)

Incident

Property	Type	Description
Url	string
Props	value{}

Enums

EnumAttachmentType

Name	Value	Description
Note	note
Report	report
Graphic	graphic
CameraImage	cameraimage
video	video
Other	other

EnumStateFlags (Flags)

Name	Value	Description
Alarm	0x1
Fault	0x2
Message	0x4
Warning	0x8
PreAlarm	0x10
RevAlarm	0x20
RevFault	0x40
RevMessage	0x80
Active	0x100
Disarmed	0x200
Locked	0x400
Off	0x800
Unknown	0x1000
Armed	0x2000
Revision	0x4000
Simulation	0x8000

EnumEventStateFlags (Flags)

Name	Value	Description
Accepted	0x1
Deferred	0x4
Completed	0x8
Ended	0x10
Locked	0x20
Hidden	0x400

EnumEventProcessingFlags (Flags)

Name	Value	Description
IsNotification	0x1
IsCompleted	0x2
NoArchiving	0x4

EnumPaginationScroll

Name	Value	Description
Offset	0	Scrolls to fixed position.
Next	1	Scrolls to next items for given context.
Prev	2	Scrolls to previous items for given context.

EnumDatapointType

Name	Value	Description
Group	1
Object	2
Member	3
Filter	4
UserAlarm	6
EventGroup	7
MetaObject ≥wg 0.1.0	8

Last modified September 25, 2026