Service: DeviceType

Reading and editing the device types

Functions

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

Notifications

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

Objects

DeviceType

Property	Type	Description
Id	guid	(Unique, Readonly)
Code	string	(Unique) Code, used for references.
Name	string	(Localized) Display name, if empty ‘code’ is used.
Order	string	(Unique) 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 graphic file.
Categories	string[]	Assigned categories, referenced by their code.
ExtRef	string	(Unique) Alternative reference for CAD symbol mapping.
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

Enums

EnumPaginationScroll

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