Get Menu Levels
post
/config/sim/v2/setup/getMenuLevels
Gets all the Menu Levels configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Menu Levels in organization.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Menu Level objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Menu Level objects of the organization.
Show Source
-
Array of:
object MenuLevelv2
Model for Menu Level for an organization
Nested Schema : MenuLevelv2
Type:
objectModel for Menu Level for an organization
Show Source
-
defaultMIMstrGrpObjNum:
integer
Object number of default menu item master group associated with the Menu Level.Example:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 - menuLevelEntries: array menuLevelEntries
- menuLevelType: string
-
name:
object name
Menu Level Name
-
objectNum:
integer
Object number the menu levelExample:
1 -
options:
string
A string value of 0s and 1s of length 8 representing the enablement or disablement of the options associated.Example:
10000000 -
optionsExt:
object MenuLevel_optionsExt
An object containing the descriptive options list associated with the Menu Level
Nested Schema : name
Type:
objectMenu Level Name
Example:
{
"1":"Property",
"2":"Eigentum",
"3":"Propiedad"
}Nested Schema : MenuLevel_optionsExt
Type:
objectAn object containing the descriptive options list associated with the Menu Level
Show Source
-
enableBoundToParent:
boolean
Select to change to default menu level when a workstation operator presses a touchscreen button corresponding to any menu level in this Menu Level Set again to turn off the level.Example:
false -
enableRevertToDefaultLevelOnKeyPress:
boolean
Select to switch the active parent menu item when the active menu level changes.Example:
false