Service: Pane
Reading and editing panes
Provices read/write access to the pane Data Objects.
Functions
| Result | Name / Params | Comment |
|---|
| GetResult | pane.Get | Returns a filtered list of Pane 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 | pane.Get | Returns a filtered list of Pane 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) |
| Pane | pane.GetOne | Returns a single Pane Object identified by the given id. |
| id | guid | The Pane's id. |
| select | string[] | (Optional) List of properties that should be contained in the result object. |
| guid | pane.Create | Creates the Pane in the system and returns the id of the Pane. The Pane must not have an id. If an id is set, the creation is rejected and an empty id is returned. |
| object | Pane | The Pane to create. |
| bool | pane.Update | Updates a Pane with data from the provided Object. |
| object | Pane | Pane to update |
| bool | pane.Set | Sets specific properties of a Pane Object. |
| id | guid | Id of the Pane 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 | pane.Delete | Deletes a Pane Object. Returns true if successfully deleted or if no such Object existed to begin with. |
| id | guid | Id of the Pane to delete. |
| bool | pane.BulkModify | Performs a bulk of changes at once. |
| create | Pane[] | (Optional) List of Pane Objects to create. |
| update | Pane[] | (Optional) List of Pane Objects to update. |
| set | ObjectAspect[] | (Optional) List of Pane Object properties to set. |
| delete | guid[] | (Optional) List of Pane ids to delete. |
Notifications
| Name / Params | Comment |
|---|
| pane.Created | Notifies about new Pane Objects. |
| objects | Pane[] | Newly created Pane Objects. |
| pane.Updated | Notifies about updated Pane Objects. |
| objects | Pane[] | Changed Pane Objects. |
| pane.Deleted | Notifies about deleted Pane Objects. |
| ids | guid[] | Ids of the deleted Pane Objects. |
Objects
Pane
| Property |
Type |
Description |
| Id |
guid |
(Unique, Readonly) |
| Name |
string |
(Unique, Localized) Display name |
| Desc |
string |
User defined description |
| Flags |
int |
Content configuration See EnumerationConfigContent. |
| EditTime |
time |
(Readonly, Not in default set) |
| EditUser |
string |
(Readonly, Not in default set) |
Enums
EnumerationConfigContent
| Name |
Value |
Description |
| None |
0 |
|
| ConfigContent |
1 |
Content configurable by settings |
Last modified September 25, 2026