Service: Datapoint

Reading, editing and operating Datapoints and getting their States

Functions

Result	Name / Params			Comment
guid	datapoint.Create			Creates the Datapoint in the system and returns the id of the Datapoint. The Datapoint must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	DatapointRaw	The Datapoint to create.
bool	datapoint.Update			Updates a Datapoint with data from the provided Object.
		id	guid	Id of the Datapoint to update.
		object	DatapointRaw	Datapoint to update
bool	datapoint.Set			Sets specific properties of a Datapoint Object.
		id	guid	Id of the Datapoint 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.
Datapoint	datapoint.GetOne			Returns a single Datapoint Object identified by the given id.
		mode	DataMode	(Optional) View of the object to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		id	guid	(Optional) The Datapoint's id.
		url	string	(Optional) A URL that identifies the Datapoint.
		type	string	(Optional) The Datapoint's type.
		category	string	(Optional) The Datapoint's category.
		name	string	(Optional) The Datapoint's name.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid[]	datapoint.GetChildrenIds			Returns a list of children Objects for a given id.
guid[]		id	guid	Id of the Datapoint to get the children ids for.
Command[]	datapoint.GetCommands			Retrieves a list of possible commands for an Object.
Command[]		id	guid	Id of the Datapoint to fetch the commands for.
bool	datapoint.ExecuteCommand			Executes a command.
		id	guid	Id of the Datapoint to execute the command for.
		commandId	string	Id of the command to execute.
		props	value{}	Command dependent parameters.
bool	datapoint.BulkModify			Performs a bulk of changes at once. The changes are applied transactionally, so if any of the individual changes fails, none of the changes are applied.
		create	DatapointRaw[]	(Optional) List of Datapoint Objects to create.
		update	DatapointRaw[]	(Optional) List of Datapoint Objects to update.
		set	ObjectAspect[]	(Optional) List of Datapoint Object properties to set.
		delete	guid[]	(Optional) List of Datapoint ids to delete.
		deleteDependents	bool	(Optional) If set to true descendant of the Object identified by 'id' will also be deleted. If the parameter is not set, the default value is false.
bool	datapoint.Delete			Deletes a Datapoint Object. Returns true if successfully deleted or if no such Object existed to begin with.
		id	guid	Id of the Datapoint to delete.
		deleteDependents	bool	(Optional) If set to true descendant of the Object identified by 'id' will also be deleted. If the parameter is not set, the default value is false.
DatapointGetResult	datapoint.Get			Returns a filtered list of Datapoint Objects.
		mode	DataMode	(Optional) View of the objects to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		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.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
DatapointGetResult	datapoint.GetNext			Returns a filtered list of Datapoint 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	PaginationScroll	(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination.
		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.

Notifications

Name / Params			Comment
datapoint.Created			Notifies about new Datapoint Objects.
	objects	Datapoint[]	Newly created Datapoint Objects.
datapoint.Updated			Notifies about updated Datapoint Objects.
	objects	Datapoint[]	Changed Datapoint Objects.
datapoint.Deleted			Notifies about deleted Datapoint Objects.
	ids	guid[]	Ids of the deleted Datapoint Objects.
datapoint.State			Notifies of State changes.
	objects	DatapointStateNotify[]	Modified States.

Objects

Datapoint

This object extends DatapointRaw.

Property	Type	Description
HolderIds	guid[]	(Readonly) Additional parents where the datapoint is displayed.
DisplayName	string	(Readonly, Localized) Computed datapoint name.
State	DatapointState	Effective datapoint State.
Icon	string	The icon depending on device type and category
SensorNumber	int	(Optional) Effective sensornumber, computed from link or element name
ValueInfos	ValueInfos	(Optional, Computed) Effective threshold values for value datapoints
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

DatapointState

Property	Type	Description
Flags	StateFlags	The current State of the datapoint. The different States are flags in a short value
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	guid[]	Ids of control operations (COPs) that are currently active for this datapoint.
CopFlags	StateFlags	The datapoint states (as flags) that were set by control operations.
StatusValue_DWord	int	Legacy status value for adapter extensions.
Commands	X4DeviceCommand[]	Context sensitive available commands for datapoints of X4 adapter extension.
MergeAlarmStates	bool	Indicates whether alarm states should be merged for states of the same URL with different origins.

PrioDef

Property	Type	Description
Alarm	int	Prio for Alarm Events.
Fault	int	Prio for Fault Events.
Message	int	Prio for Message Events.
PreAlarm	int	Prio for PreAlarm Events.
Warning	int	Prio for Warning Events.
Off	int	Prio for Off Events.
Revision	int	Prio for Revision Events.
Active	int	Prio for Active Events.

UserAlarm

Property	Type	Description
Type	StateFlags	Type of the Event to trigger.
Text	string	Event text to set.
Prio	int	Event priority to set upon creation.

CommandMapping

Property	Type	Description
SrcCommand	string	The original id of the command.
DstCommand	string	The id to map the command to.
DstDatapointId	guid	Target datapoint id of the command.

ValueInfo

Property	Type	Description
Precision	int	Amount of floating point digits.
Unit	string	The value’s unit.
SaveHistory	bool	If true the value’s history will be logged.

ValueTransformation

Property	Type	Description
SrcFrom	float	Original ranges low point.
SrcTo	float	Original ranges high point.
DstFrom	float	Target ranges low point.
DstTo	float	Target ranges high point.

ValueMapping

Property	Type	Description
Value	string	The value.
RangeFrom	float	Range low point.
RangeTo	float	Range high point.
RangeDeadBand	float	Range’s dead band.
StateType	StateFlags	Only one logical value is set.
StateText	string
EventType	StateFlags	Only one logical value is set.
EventId	string
EventText	string
EventPrio	int

CamInfo

Property	Type	Description
NorthAngle	float
FocalLength	float
ViewAngle	float

CamPreset

Property	Type	Description
Id	string	Internal Id, used as default display name.
Name	string	Optional display name.
LinkId	string	Id used by the SST to identify the preset.

GeoPosition

Property	Type	Description
Latitude	float
Longitude	float
Altitude	float

PtzInfo

Property	Type	Description
PanAngle	int	Value should be in range [0, 359].
TiltAngle	int	Value should be in range [0, 90].
ZoomValue	float	Value should be >= 1.0

Link

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

Command

Property	Type	Description
Id	string	The command’s unique id.
Name	string	(Localized) Localized name, can be displayed to the user.

ValueInfos

Property	Type	Description
ValueFrom	float	(Optional) lower border of value
ValueTo	float	(Optional) upper border of value
ValueMaxHigh	float	(Optional) upper value of value datapoints
ValueMaxLow	float	(Optional) upper value - deadband of value datapoints
ValueMinHigh	float	(Optional) lower value + deadband of value datapoints
ValueMinLow	float	(Optional) lower value of value datapoints

DatapointGetResult

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

DatapointRaw

Property	Type	Description
Id	guid	(Readonly)
Code	string	Code, used for references in graphics.
ParentId	guid	Parent Object id.
SegmentId	guid	Assigned segment.
MemberIds	guid[]	Children of a group or metaobject datapoint.
Type	int	See DatapointType.
Category	string	Category code.
Name	string	Datapoint’s name, might be a language resource id.
Desc	string	Description, might be a resource string.
Tags	string	Tags enclosed in vertical bars (pipes), such as "
LocationId	guid	Associated location id.
DeviceType	string	Device type code.
GeoPos	GeoPosition	Geographical coordinates.
Note	string	User note.
Link	Link	Url, type and Properties of the linked SST Object.
Props	value{}	Additional properties.
Text	string	Text.
Graphics	string[#]	Graphics.
TextMacros	string[#]	Text macros.
Script	string	Script.
Prios	PrioDef	Priorities for Events.
CommandMappings	CommandMapping[]	Command mappings.
AssociatedDatapoints	guid[]	Associated Datapoints.
Concepts	string[]	Concepts.
UserAlarm	UserAlarm	User alarm.
Filter	string	Filter.
FilterEmptyText	string	State text to use if the datapoint’s filter isn’t matched.
AggregateStates	bool	Indicates if the filter datapoint’s States should be aggregated.
FilteredAggregatedStates	int[]	List of aggregated datapoint State types for filter datapoints.
ResponsibleStation	int	The number of the station which is responsible to evaluate the value mappings for a filter.
CamInfo	CamInfo	Camera infos.
CamPresets	CamPreset[]	Camera presets.
ValueInfo	ValueInfo
ValueMapping	ValueMapping[]
ValueTransformation	ValueTransformation

DatapointStateNotify

Property	Type	Description
Id	guid
State	DatapointState

X4DeviceCommand

Property	Type	Description
Id	int
GlobalId	int
Info	int

Enums

DatapointType

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

StateFlags (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

PaginationScroll

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.

Last modified September 25, 2026