Service: Profile

Reading and editing the profiles

Functions

ResultName / ParamsComment
ProfileGetResultprofile.GetReturns a filtered list of Profile Objects.
modestring(Optional) View of the objects to return: raw or effective. Default is effective. See DataMode.
includestring(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
filterDataFilter(Optional) Filter definition which determines the result set.
sortDataSortItem[](Optional) Sorting definition as a list of properties with order.
offsetint(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
limitint(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
selectstring[](Optional) List of properties that should be contained in the result objects.
ProfileGetResultprofile.GetNextReturns a filtered list of Profile Objects as a follow up to a previous Get call.
contextstringThe context received within the last get result. Mandatory for subsequent get calls with pagination.
scrollint(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See PaginationScroll.
offsetint(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
limitint(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
Profileprofile.GetOneReturns a single Profile Object identified by the given id.
idguidThe Profile's id.
modestring(Optional) View of the object to return: raw or effective. Default is effective. See DataMode.
includestring(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
selectstring[](Optional) List of properties that should be contained in the result object.
guidprofile.CreateCreates 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.
objectProfileRawThe Profile to create.
boolprofile.UpdateUpdates a Profile with data from the provided Object.
idguidId of the Profile to update.
objectProfileRawProfile to update
boolprofile.SetSets specific properties of a Profile Object.
idguidId of the Profile to modify.
propsvalue{}(Key: SymbolPath) List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
boolprofile.DeleteDeletes a Profile Object. Returns true if successfully deleted or if no such Object existed to begin with.
idguidId of the Profile to delete.
boolprofile.BulkModifyPerforms a bulk of changes at once.
createProfileRaw[](Optional) List of Profile Objects to create.
updateProfileRaw[](Optional) List of Profile Objects to update.
setObjectAspect[](Optional) List of Profile Object properties to set.
deleteguid[](Optional) List of Profile ids to delete.

Notifications

Name / ParamsComment
profile.CreatedNotifies about new Profile Objects.
objectsProfile[]Newly created Profile Objects.
profile.UpdatedNotifies about updated Profile Objects.
objectsProfile[]Changed Profile Objects.
profile.DeletedNotifies about deleted Profile Objects.
idsguid[]Ids of the deleted Profile Objects.

Objects

Profile

This object extends ProfileRaw.

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

ProfileAssignment

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

ProfileGetResult

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

ProfileRaw

Property Type Description
Id guid (Readonly)
Type int The profile’s type. See ProfileType.
Name string Name of the profile.
Desc string Description.
LdapName string Links the profile to an LDAP entity.
ExtRef string Used for matching a profile of an external source.
ProfileIds guid[] Contained child profiles.
Assignments ProfileAssignment[] Contained child profiles.

Enums

ProfileType

Name Value Description
User 1
Station 2
Function 3
Rights 4
Last modified September 25, 2026