Get Menu Levels
post
/config/sim/v1/setup/getmenulevels
Gets all the Menu Levels configured
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : MenuLevelGetRequestBody
Type:
Show Source
object-
include:
string
Example:
locations -
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 translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Menu Levels in organization.
Root Schema : MenuLevelGetResponse
Type:
objectModel for Menu Level for an organization
Show Source
-
defaultMIMstrGrpName(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
defaultMIMstrGrpObjNum(required):
integer
Object number of default menu item master group associated with the Menu Level.Example:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitName(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 - menuLevelEntries(required): array menuLevelEntries
- menuLevelType(required): string
-
name(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
objectNum(required):
integer
Object number the menu levelExample:
1 -
options(required):
string
A string value of 0s and 1s of length 8 representing the enablement or disablement of the options associated.Example:
10000000 -
optionsExt(required):
object MenuLevel_optionsExt
An object containing the descriptive options list associated with the Menu Level
Nested Schema : TranslatedString
Type:
objectAdditional Properties Allowed
Show Source
A string that contains translations into multiple languages
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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found