Service: DeviceType

Reading and editing the device types

Functions

Result	Name / Params			Comment
DeviceTypeGetResult	deviceType.Get			Returns a filtered list of DeviceType 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.
DeviceTypeGetResult	deviceType.GetNext			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	(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)
DeviceType	deviceType.GetOne			Returns a single DeviceType Object identified by the given id.
		id	guid	The DeviceType'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	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	DeviceTypeRaw	The DeviceType to create.
bool	deviceType.Update			Updates a DeviceType with data from the provided Object.
		id	guid	Id of the DeviceType to update.
		object	DeviceTypeRaw	DeviceType to update
bool	deviceType.Set			Sets specific properties of a DeviceType Object.
		id	guid	Id of the DeviceType 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	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	DeviceTypeRaw[]	(Optional) List of DeviceType Objects to create.
		update	DeviceTypeRaw[]	(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

This object extends DeviceTypeRaw.

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

DeviceTypeGetResult

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

DeviceTypeRaw

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 graphic file.
Categories	string[]	Assigned categories, referenced by their code.
ExtRef	string	(Unique) Alternative reference for CAD symbol mapping.

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