Warehouse 
📊 Overview: 8 Functions
Extends: DataClass
🕐 Last updated: 2026-01-13T16:04:13.746Z
📑 Table of Contents
- ⚙️ Functions
- Regular Functions
- restExecutePromptFormula (1 param) →
Object - restExecuteFormula (1 param) →
Object - restTest (1 param) →
Object - restStartPage (1 param) →
Object - restInitialScan (1 param) →
Object - restDisplayPrinterList (1 param) →
Object - restSetLabelPrinter (1 param) →
Object - restScanTest (1 param) →
Object
- restExecutePromptFormula (1 param) →
- Regular Functions
- 🔗 Related Items
Functions
Regular Functions
restExecutePromptFormula
Function restExecutePromptFormula($RestPostDataObject : Object) -> Object
Displays a prompt dialog for user input and executes a formula on the result; returns WarehouseViewData with optional redirect
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restExecuteFormula
Function restExecuteFormula($RestPostDataObject : Object) -> Object
Executes a formula with provided parameters and context; returns WarehouseViewData with optional alert or redirect
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restTest
Function restTest($RestPostDataObject : Object) -> Object
Test REST endpoint displaying a prompt dialog and showing test data; used for development/debugging
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restStartPage
Function restStartPage($RestPostDataObject : Object) -> Object
Displays the warehouse app start page with initial UI and scanner setup; entry point for warehouse workflows
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restInitialScan
Function restInitialScan($RestPostDataObject : Object) -> Object
Routes scanned barcode to appropriate handler (BoxLabel, Pallet, MaterialStock) or prompts to rescan if invalid
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restDisplayPrinterList
Function restDisplayPrinterList($RestPostDataObject : Object) -> Object
Displays UI to select active label printer from available label printers in system; updates user settings
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restSetLabelPrinter
Function restSetLabelPrinter($RestPostDataObject : Object) -> Object
Sets the active label printer for the current staff member; confirms selection and returns to start page
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restScanTest
Function restScanTest($RestPostDataObject : Object) -> Object
Test endpoint for scanner functionality; returns mock data and enables scanner for testing
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
Related Items
🗂️ Tables
- Warehouse - ORDA DataClass class for Warehouse table
Generated from Warehouse.4dm