Service: DatapointPattern

Reading, editing and operating Datapoint patterns

Functions

ResultName / ParamsComment
DatapointPatternGetResultdatapointPattern.GetReturns a filtered list of DatapointPattern Objects.
modestring(Optional) View of the objects to return: raw or effective. Default is effective. See DataMode.
includestring(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
filterDataFilter(Optional) Filter definition which determines the result set.
sortDataSortItem[](Optional) Sorting definition as a list of properties with order.
offsetint(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
limitint(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
selectstring[](Optional) List of properties that should be contained in the result objects.
DatapointPatternGetResultdatapointPattern.GetNextReturns a filtered list of DatapointPattern Objects as a follow up to a previous Get call.
contextstringThe context received within the last get result. Mandatory for subsequent get calls with pagination.
scrollint(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See PaginationScroll.
offsetint(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
limitint(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
DatapointPatterndatapointPattern.GetOneReturns a single DatapointPattern Object identified by the given id.
idguidThe DatapointPattern's id.
modestring(Optional) View of the object to return: raw or effective. Default is effective. See DataMode.
includestring(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
selectstring[](Optional) List of properties that should be contained in the result object.
guiddatapointPattern.CreateCreates the DatapointPattern in the system and returns the id of the DatapointPattern. The DatapointPattern must not have an id. If an id is set, the creation is rejected and an empty id is returned.
objectDatapointPatternRawThe DatapointPattern to create.
booldatapointPattern.UpdateUpdates a DatapointPattern with data from the provided Object.
idguidId of the DatapointPattern to update.
objectDatapointPatternRawDatapointPattern to update
booldatapointPattern.SetSets specific properties of a DatapointPattern Object.
idguidId of the DatapointPattern to modify.
propsvalue{}(Key: SymbolPath) List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
booldatapointPattern.DeleteDeletes a DatapointPattern Object. Returns true if successfully deleted or if no such Object existed to begin with.
idguidId of the DatapointPattern to delete.
booldatapointPattern.BulkModifyPerforms a bulk of changes at once.
createDatapointPatternRaw[](Optional) List of DatapointPattern Objects to create.
updateDatapointPatternRaw[](Optional) List of DatapointPattern Objects to update.
setObjectAspect[](Optional) List of DatapointPattern Object properties to set.
deleteguid[](Optional) List of DatapointPattern ids to delete.

Notifications

Name / ParamsComment
datapointPattern.CreatedNotifies about new DatapointPattern Objects.
objectsDatapointPattern[]Newly created DatapointPattern Objects.
datapointPattern.UpdatedNotifies about updated DatapointPattern Objects.
objectsDatapointPattern[]Changed DatapointPattern Objects.
datapointPattern.DeletedNotifies about deleted DatapointPattern Objects.
idsguid[]Ids of the deleted DatapointPattern Objects.

Objects

DatapointPattern

This object extends DatapointPatternRaw.

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

DatapointPatternGetResult

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

DatapointPatternRaw

Property Type Description
Id guid (Readonly)
Order string Defines the sequential order of the Objects. Should contain only letters A-Z, must never end with ‘A’.
Name string Name of the pattern.
Desc string Free description.
Filter string Expression which selects the affected datapoints.
Text string Text.
Script string Script.
Graphics string[#] Graphics.
TextMacros string[#] Text macros.
Last modified September 25, 2026