Get Menu Levels
post
/config/sim/v1/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
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Menu Levels in organization.
Root Schema : MenuLevelGetResponsev1
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 MenuLevelv1
Model for Menu Level for an organization
Nested Schema : MenuLevelv1
Type:
objectModel for Menu Level for an organization
Show Source
-
defaultMIMstrGrpName:
object defaultMIMstrGrpName
Default MIMS Group Name
-
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 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 - menuLevelEntries: array menuLevelEntries
- menuLevelType: string
-
name:
object name
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 : defaultMIMstrGrpName
Type:
objectDefault MIMS Group Name
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}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