| SegmentGetResult | segment.Get | Returns a filtered list of Segment 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. |
| SegmentGetResult | segment.GetNext | 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 | (Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See PaginationScroll. |
| 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. |
| 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 | 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. |
| object | SegmentRaw | The Segment to create. |
| bool | segment.Update | Updates a Segment with data from the provided Object. |
| id | guid | Id of the Segment to update. |
| object | SegmentRaw | Segment to update |
| bool | segment.Set | Sets specific properties of a Segment Object. |
| id | guid | Id of the Segment 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 | segment.Delete | Deletes a Segment Object. Returns true if successfully deleted or if no such Object existed to begin with. |
| id | guid | Id of the Segment to delete. |
| bool | segment.BulkModify | Performs a bulk of changes at once. |
| create | SegmentRaw[] | (Optional) List of Segment Objects to create. |
| update | SegmentRaw[] | (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. |