Service: Settings

Reading and editing the settings

Provides read/write access to the WinGuard settings.

Functions

Result	Name / Params			Comment
SettingGetResult	settings.Get			Returns a filtered list of Setting 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.
Setting	settings.GetOne			Returns a single Setting Object identified by the given id.
		id	guid	The Setting'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	settings.Create			Creates the Setting in the system and returns the id of the Setting. The Setting must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	SettingRaw	The Setting to create.
bool	settings.Update			Updates a Setting with data from the provided Object.
		id	guid	Id of the Setting to update.
		object	SettingRaw	Setting to update
bool	settings.Set			Sets specific properties of a Setting Object.
		id	guid	Id of the Setting 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	settings.Delete			Deletes a Setting Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Setting to delete.
bool	settings.BulkModify			Performs a bulk of changes at once.
		create	SettingRaw[]	(Optional) List of Setting Objects to create.
		update	SettingRaw[]	(Optional) List of Setting Objects to update.
		set	ObjectAspect[]	(Optional) List of Setting Object properties to set.
		delete	guid[]	(Optional) List of Setting ids to delete.
value	settings.GetValue			Returns the value of a concrete setting item for the given context and origin.
		key	string	Key of the concrete setting item to return.
		origin	string	(Optional) Scope for the request.
		context	SettingTarget[]	(Optional) List of involved targets.
value{}	settings.GetValues			Returns a list of setting items for the given context and origin.
		keys	string[]	List of keys of setting items to return, this filters the result.
		origin	string	(Optional) Scope for the request.
		context	SettingTarget[]	(Optional) List of involved targets.
SettingGetResult	settings.GetNext			Returns a filtered list of Setting 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	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)

Notifications

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

Objects

Setting

Property	Type	Description
Id	guid	(Readonly) Unique ID of the Data Object.
Target	SettingTarget[]	Combination of targets for which the definition is intended.
Origin	string	Origin of the setting, usually the GUID of the providing Extension. Empty for application settings.
Key	string	Identifies the setting. The key is defined per origin.
Value	value	Value of the setting.
Access	string	Defines the replication behavior. See SettingAccess.

SettingTarget

Property	Type	Description
Type	string	Type of the target. See SettingTargetType.
Id	string	ID of the target, usually a GUID.

SettingTargetType

Name	Value	Description
Extension	extension	Configured Extension of an application.
Station	station	Station of a networked application.
User	user	User of the application.
Profile	profile	Profile that defines a role, for example.

SettingAccess

Name	Value	Description
Global		Default behavior. Strongly recommended. Setting is replicated to every station (according to segmentation rules if applicable).
Origin	origin	Setting is only replicated to the top-tier servers and the stations of the Extension referenced (by GUID) in the origin property.

SettingGetResult

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

SettingRaw

Property	Type	Description
Id	guid	(Readonly)
Target	SettingTarget[]	Combination of targets for which the definition is intended.
Origin	string	Origin of the setting, usually the GUID of the providing Extension. Empty for application settings.
Key	string	Identifies the setting. The key is defined per origin.
Value	value	Value of the setting.
Access	string	Defines the replication behavior. See SettingAccess.

Last modified September 25, 2026