Service: Profile

Reading and editing the profiles

Functions

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

Notifications

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

Objects

Profile

Property	Type	Description
Id	guid	(Unique, Readonly)
Type	int	The profile’s type. See EnumProfileType.
Name	string	(Unique, Localized) Name of the profile.
Desc	string	(Localized) Description.
LDAPName <wg 0.6.0	string	Links the profile to an LDAP entity.
ExtRef ≥wg 0.6.0	string	Used for matching a profile of an external source.
ProfileIds <wg 0.3.0	guid[]	Contained child profiles.
Assignments ≥wg 0.3.0	ProfileAssignment[]	Contained child profiles.
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

ProfileAssignment ≥wg 0.3.0

Property	Type	Description
Id	guid	Referenced profile id.
Active	bool	Active state.

Enums

EnumProfileType

Name	Value	Description
User	1
Station	2
Function	3
Rights	4

Last modified September 25, 2026