Service: Segment

Reading and editing the segments

Functions

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

Notifications

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

Objects

Segment

Property	Type	Description
Id	guid	(Unique, Readonly)
Name	string
Desc	string
GeoPos	GeoPosition	Geographical coordinates.
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

Last modified September 25, 2026