Service: DatapointPattern
Reading, editing and operating Datapoint patterns
Functions
| Result | Name / Params | Comment |
|---|
| GetResult | datapointpattern.Get | Returns a filtered list of DatapointPattern 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. (Max : 100000) |
| GetResult | datapointpattern.Get | Returns a filtered list of DatapointPattern 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 | Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll. |
| 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) |
| DatapointPattern | datapointpattern.GetOne | Returns a single DatapointPattern Object identified by the given id. |
| id | guid | The DatapointPattern's id. |
| select | string[] | (Optional) List of properties that should be contained in the result object. |
| guid | datapointpattern.Create | Creates 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. |
| object | DatapointPattern | The DatapointPattern to create. |
| bool | datapointpattern.Update | Updates a DatapointPattern with data from the provided Object. |
| object | DatapointPattern | DatapointPattern to update |
| bool | datapointpattern.Set | Sets specific properties of a DatapointPattern Object. |
| id | guid | Id of the DatapointPattern 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 | datapointpattern.Delete | Deletes a DatapointPattern Object. Returns true if successfully deleted or if no such Object existed to begin with. |
| id | guid | Id of the DatapointPattern to delete. |
| bool | datapointpattern.BulkModify | Performs a bulk of changes at once. |
| create | DatapointPattern[] | (Optional) List of DatapointPattern Objects to create. |
| update | DatapointPattern[] | (Optional) List of DatapointPattern Objects to update. |
| set | ObjectAspect[] | (Optional) List of DatapointPattern Object properties to set. |
| delete | guid[] | (Optional) List of DatapointPattern ids to delete. |
Notifications
| Name / Params | Comment |
|---|
| datapointpattern.Created | Notifies about new DatapointPattern Objects. |
| objects | DatapointPattern[] | Newly created DatapointPattern Objects. |
| datapointpattern.Updated | Notifies about updated DatapointPattern Objects. |
| objects | DatapointPattern[] | Changed DatapointPattern Objects. |
| datapointpattern.Deleted | Notifies about deleted DatapointPattern Objects. |
| ids | guid[] | Ids of the deleted DatapointPattern Objects. |
Objects
DatapointPattern
| Property |
Type |
Description |
| Id |
guid |
(Unique, Readonly) Unique Object id. |
| Order |
string |
(Unique) Defines the sequential order of the Objects. Should contain only letters A-Z, must never end with ‘A’. |
| Name |
string |
(Localized) Name of the pattern. |
| Desc |
string |
(Localized) Free description. |
| Filter |
string |
Expression which selects the affected Datapoints. |
| Text |
string |
Text. |
| Script ≥wg 0.4.3 |
string |
Script. |
| Graphics |
string[#] |
Graphics. |
| TextMacros |
string[#] |
Text macros. |
| EditTime |
time |
(Readonly, Not in default set) |
| EditUser |
string |
(Readonly, Not in default set) |
Last modified September 25, 2026