Service: Extension

Reading and editing Extensions

Functions

Result	Name / Params			Comment
ExtensionGetResult	extension.Get			Returns a filtered list of Extension Objects.
		mode	DataMode	(Optional) View of the objects to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		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.
ExtensionGetResult	extension.GetNext			Returns a filtered list of Extension 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	PaginationScroll	(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination.
		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)
Extension	extension.GetOne			Returns a single Extension Object identified by the given id.
		id	guid	The Extension's id.
		mode	DataMode	(Optional) View of the object to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	extension.Create			Creates the Extension in the system and returns the id of the Extension. The Extension must not have an id. If an id is set, a Data.Validation error is thrown.
guid		object	ExtensionRaw	The Extension to create.
bool	extension.Update			Updates a Extension with data from the provided Object.
		id	guid	Id of the Extension to update.
		object	ExtensionRaw	Extension to update
bool	extension.Set			Sets specific properties of a Extension Object.
		id	guid	Id of the Extension 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	extension.Delete			Deletes a Extension Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Extension to delete.
bool	extension.BulkModify			Performs a bulk of changes at once.
		create	ExtensionRaw[]	(Optional) List of Extension Objects to create.
		update	ExtensionRaw[]	(Optional) List of Extension Objects to update.
		set	ObjectAspect[]	(Optional) List of Extension Object properties to set.
		delete	guid[]	(Optional) List of Extension ids to delete.
bool	extension.Restart			Restarts an Extension.
bool		id	guid	Id of the Extension.

Notifications

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

Objects

Extension

This object extends ExtensionRaw.

Property	Type	Description
Traits	string[]	(Readonly) Supported Traits. See ModuleTrait.
Version	string	(Readonly) Current version of the module.
Type	string	(Readonly) Type classification See ExtensionType.
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

ExtensionGetResult

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

ExtensionRaw

Property	Type	Description
Id	guid	(Readonly)
SegmentId	guid	Assigned data segment.
Code	string	Code of the Extension, used in URLs.
Name	string	Name of the Extension, if empty ‘code’ is used.
Desc	string	Description, might be a resource string.
Module	string	Code of the used module.
IsManaged	bool	Extension is started automatically from local station. No API Key needed.
AccessToken	string	Authentication token for externally started Extension.
AutomaticStations	bool	The stations on which this extension should run are determined automatically. The Stations Property is ignored if this is true.
Stations	string[]	List of station codes. On these stations the Extension can connect or will be started.
MainStations	string[]	List of (ordered) main connections.
ModuleXmlFile	string	Used Module.xml file.
AppXmlFile	string	Used App.xml file.
Configuration	string	Used configuration.
CustomFolder	string	Custom folder if appropriate.
RedirectUris	string[]

Enums

ExtensionType

Name	Value	Description
System	sys	Internally managed extension
Module	mod	Default extension type
Api	api	Simple extension to access api functions

ModuleTrait

Name	Value	Description
Adapter	adapter	Interface to external objects with States, and Events.
Monitor	monitor	Provides data streams to visualize monitor information.
AP	ap	Supports querying Objects for Automatic Data Supply.
UI	ui	Provides ui content.
X4	X4	This is a legacy X4 module.
Browsable	browsable	Supports querying Objects for specific Nodes.
Settings	settings	Has individual Settings.
Demo	demo	Can run without license.
NoLic	nolic	Can run without license.
MultiStation	multistation	Can be operated at several stations.
Concurrent	concurrent	Allows creating Events on stations running in local mode. Use responsibly. Only recommended for notification Events.
MultiClient	multiclient	Multiple clients of this module can connect simultaneously.
ControlPanel	controlpanel	Can display an Extension provided Control Panel.
UserAuthentication	userauth	Uses user sessions obtained from OAuth to authenticate against the AOP Node.
Help	help	Help files are available for display.
Manageable	manageable	The module can be managed by the App, e.g. started and stopped.
LocalObjects	localobjects	Only exchange local Objects (e.g. local telephones) between the AOP server and the extension, i.e. the extension knows different objects depending on the station it runs on and thus can only trigger app states and app events for these objects. The extension may still receive operations for “non-local” objects.

Last modified September 25, 2026