Service: Handling

Reading, editing and operating Handlings

Functions

Result	Name / Params			Comment
HandlingGetResult	handling.Get			Returns a filtered list of Handling Objects.
		mode	string	(Optional) View of the objects to return: raw or effective. Default is effective. See DataMode.
		include	string	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
		filter	DataFilter	(Optional) Filter definition which determines the result set.
		sort	DataSortItem[]	(Optional) Sorting definition as a list of properties with order.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
		select	string[]	(Optional) List of properties that should be contained in the result objects.
HandlingGetResult	handling.GetNext			Returns a filtered list of Handling Objects as a follow up to a previous Get call.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		scroll	int	(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See PaginationScroll.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
Handling	handling.GetOne			Returns a single Handling Object identified by the given id.
		id	guid	The Handling's id.
		mode	string	(Optional) View of the object to return: raw or effective. Default is effective. See DataMode.
		include	string	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	handling.Create			Creates the Handling in the system and returns the id of the Handling. The Handling must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	HandlingRaw	The Handling to create.
bool	handling.Update			Updates a Handling with data from the provided Object.
		id	guid	Id of the Handling to update.
		object	HandlingRaw	Handling to update
bool	handling.Set			Sets specific properties of a Handling Object.
		id	guid	Id of the Handling to modify.
		props	value{}	(Key: SymbolPath) List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	handling.Delete			Deletes a Handling Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Handling to delete.
bool	handling.BulkModify			Performs a bulk of changes at once.
		create	HandlingRaw[]	(Optional) List of Handling Objects to create.
		update	HandlingRaw[]	(Optional) List of Handling Objects to update.
		set	ObjectAspect[]	(Optional) List of Handling Object properties to set.
		delete	guid[]	(Optional) List of Handling ids to delete.

Notifications

Name / Params			Comment
handling.Created			Notifies about new Handling Objects.
	objects	Handling[]	Newly created Handling Objects.
handling.Updated			Notifies about updated Handling Objects.
	objects	Handling[]	Changed Handling Objects.
handling.Deleted			Notifies about deleted Handling Objects.
	ids	guid[]	Ids of the deleted Handling Objects.

Objects

Handling

This object extends HandlingRaw.

Property	Type	Description
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

HandlingAction

Property	Type	Description
Offset	string	Time offset to group all Events which trigger a certain timespan. Only available when Handling type is grouping.
Grouping	guid	A group datapoint which should group the handled Events. Only available when Handling type is grouping.
Condition	int[]	Additional condition to determine that all the Events have to have the particular location or datapoint in common to be grouped. Only available when Handling type is grouping. See GroupingCondition.
Duration	string	Time offset for how long the Event execution should be delayed. Only available when Handling type is delay.

HandlingFilter

Property	Type	Description
StateTypes	int[]	A set of datapoint States.
StateText	string	A custom State text the Event needs to have.
Location	guid	A location the Event must be assigned to.
DatapointCategories	string[]	A set of category codes.
Datapoints	guid[]	A set of datapoint IDs.
Extensions	string[]	A set of Extension codes.
Tags	string	Tags enclosed in vertical bars (pipes), such as "

HandlingGetResult

Property	Type	Description
Objects	Handling[]	Array of Objects.
Pagination	Pagination	Describes the result set, if not all Objects were returned.

HandlingRaw

Property	Type	Description
Id	guid	(Readonly)
Order	float	Defines the sequential order of the Objects.
Type	int	Specific Handling type. See HandlingType.
Desc	string	User defined description.
Flags	int	Handling enabled or disabled. See HandlingEnabled.
BeginTime	time	Starting time after which new Events are handled. Might be null if not set.
EndTime	time	End time after which new Events are not handled. Might be null if not set.
Filter	HandlingFilter	A filter to determine which Events should be handled.
Action	HandlingAction	A set of options for the actions that should take effect when executing the Handling.

Enums

HandlingType

Name	Value	Description
None	0
Hide	2	Hide Events handled by this Object.
Grouping	5	Group object handled by this Object.
Delay	6	Delay Event handled by this Object.

HandlingEnabled

Name	Value	Description
IsEnabled	0	Handling is enabled.
IsDisabled	1	Handling is disabled.

GroupingCondition

Name	Value	Description
SameLocation	1	The locations are identical
SameFacility	2	The locations share the same facility-level parent location
SameBuilding	3	The locations share the same building-level parent location
SameFloor	4	The locations share the same floor-level parent location
SameRoom	5	The locations share the same room-level parent location
SameDatapoint	6	The datapoints are identical
SameDatapointParent	7	The datapoint share the same parent datapoint

Last modified September 25, 2026