English
Web API
About 322 wordsAbout 1 min
2025-12-18
This page summarizes the currently available Web APIs, grouped by capability.
Application Operations
| Name | Description |
|---|---|
| open | Open a page or a host capability entry |
| hideMenu | Hide the menu |
| getCrossAppUrl | Get a cross-application access URL |
| crossNoticeChange | Listen for cross-application notice changes |
| crossTodoChange | Listen for cross-application to-do changes |
Base Capabilities
| Name | Description |
|---|---|
| fly_api | Call the base request capability |
Helper Methods
| Name | Description |
|---|---|
| handleCopy | Handle copy operations |
Library Capabilities
| Name | Description |
|---|---|
| require | Load dependencies on demand |
Object Data Operations
| Name | Description |
|---|---|
| fetch_data | Get business object data |
| fetch_describe | Get business object metadata |
| fetch_email_templates | Get email templates |
| fill_email_template | Fill an email template |
| format_field_value | Format a field value |
Object UI Actions
| Name | Description |
|---|---|
| addObject | Open the create object screen |
| editObject | Open the edit object screen |
| selectObject | Select a business object |
| viewObject | View object details |
| openDuplicateTool | Open the duplicate data handling tool |
Organization
| Name | Description |
|---|---|
| getCurrentEmployee | Get current employee information |
| getDepartmentById | Get a department by ID |
| getDepartmentsByIds | Get multiple departments by ID |
| getEmployeeById | Get an employee by ID |
| getEmployeesByIds | Get multiple employees by ID |
Storage
| Name | Description |
|---|---|
| get | Read persistent storage |
| set | Write persistent storage |
| getTemp | Read temporary storage |
| setTemp | Write temporary storage |
Tenant Customization
| Name | Description |
|---|---|
| call_controller | Call tenant-customized server-side logic |
| callPollingController | Call polling-based tenant-customized logic |
| getAsyncComponent | Get an async component |
Media
| Name | Description |
|---|---|
| compressionImage | Compress an image |
| downloadFile | Download a file |
| downloadImage | Download an image |
| getFilePreviewUrl | Get a file preview URL |
| getImagePreviewUrl | Get an image preview URL |
| previewFile | Preview a file |
| previewImage | Preview an image |
| uploadBigFile | Upload a large file |
| uploadFile | Upload a file |
Notes
- This page summarizes Web APIs only.
- For specific parameters, return values, and limitations, see the corresponding API pages.
