Service: Category

Reading and editing the categories

Provides read/write access to category Data Objects.

Functions

Result	Name / Params			Comment
CategoryGetResult	category.Get			Returns a filtered list of Category 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.
CategoryGetResult	category.GetNext			Returns a filtered list of Category 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)
Category	category.GetOne			Returns a single Category Object identified by the given id.
		id	guid	The Category'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	category.Create			Creates the Category in the system and returns the id of the Category. The Category must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	CategoryRaw	The Category to create.
bool	category.Update			Updates a Category with data from the provided Object.
		id	guid	Id of the Category to update.
		object	CategoryRaw	Category to update
bool	category.Set			Sets specific properties of a Category Object.
		id	guid	Id of the Category 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	category.Delete			Deletes a Category Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Category to delete.
bool	category.BulkModify			Performs a bulk of changes at once.
		create	CategoryRaw[]	(Optional) List of Category Objects to create.
		update	CategoryRaw[]	(Optional) List of Category Objects to update.
		set	ObjectAspect[]	(Optional) List of Category Object properties to set.
		delete	guid[]	(Optional) List of Category ids to delete.

Notifications

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

Objects

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

CategoryGetResult

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

CategoryRaw

Property	Type	Description
Id	guid	(Readonly)
Code	string	Code, used for references.
Name	string	Display name, if empty ‘code’ is used.
Order	string	Defines the sequential order. Should contain only letters A-Z, must never end with ‘A’.
Icon	string	Resource id or path of the icon.
Symbol	string	Symbol used by datapoints of this category as fallback if they don’t have a device type assigned with its own symbol.

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