Service: DataObject

Generic access to all data objects

Provides generic read access to all Data Objects and to data form definitions.

The service doesn’t have any notifications. They are only provided by the object specific services.

Functions

Result	Name / Params			Comment
GetResult	data.Get			Generic Get function for all data types. The type is selected by parameter, the rest behaves the same as type specific services.
		type	string	Selects the type of Data Object.
		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.
		limit	int	(Optional) Maximum amount of Objects that should be returned. Must be a non-negative integer.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination. Must be a non-negative integer.
		select	string[]	(Optional) A list of fields which the result objects should contain (empty or missing means a default field set will be returned).
value	data.GetOne			Returns a single Object identified by the given ID.
		type	string	Selects the type of Data Object.
		id	string	The unique ID info of the Object, for example a guid or a name.
		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.
GetResult	data.GetNext			Generic Get function for all data types as a follow up to a previous Get call. The type is selected by parameter.
		type	string	Selects the type of Data Object.
		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. Must be a non-negative integer.
		limit	int	(Optional) Maximum amount of Objects that should be returned. Must be a non-negative integer.

Enums

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