Get Menu Level Entries
post
/config/sim/v1/setup/menulevels/getMenuLevelEntries
Gets a list of all the menu levels entries for the specified menu level set
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : MenuLevelEntryGetRequestBody
Type:
Show Source
object-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
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 -
objectNum(required):
integer
Object number of the menu level setExample:
1 -
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 value. In this case, results will be filtered based on 'hierUnitId' field with value as 1012.Example:
where equals(hierUnitId,1012)
Response
Supported Media Types
- application/json
200 Response
A collection of menu level entries.
Root Schema : MenuLevelEntryGetResponsev1
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 Entry 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 Entry objects of the organization.
Show Source
-
Array of:
object MenuLevelEntryv1
Model for a Menu Level Entry
Nested Schema : MenuLevelEntryv1
Type:
objectModel for a Menu Level Entry
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
index:
integer
Object number of the menu level entryExample:
1 -
name:
object name
Name
-
objectNum:
integer
Object number of the menu level setExample:
1 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associatedExample:
00000000 -
optionsExt:
object OptionsExt_MenuLevelEntry
An object containing the descriptive options list associated with the Menu Level Entry
-
prefix:
object prefix
Prefix
-
suffix:
object suffix
Suffix
Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : OptionsExt_MenuLevelEntry
Type:
objectAn object containing the descriptive options list associated with the Menu Level Entry
Show Source
-
anonymous:
boolean
Select to mark this menu level as anonymous for the Menu Level Set.Example:
false -
default:
boolean
Select to mark this menu level as the default level for the Menu Level Set.Example:
false
Nested Schema : prefix
Type:
objectPrefix
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : suffix
Type:
objectSuffix
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}