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 of the menu level set
Root Schema : MenuLevelEntryGetResponse
Type:
objectModel for a Menu Level Entry
Show Source
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitName(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
index(required):
integer
Object number of the menu level entryExample:
1 -
name(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
objectNum(required):
integer
Object number of the menu level setExample:
1 -
options(required):
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associatedExample:
00000000 -
optionsExt(required):
object OptionsExt_MenuLevelEntry
An object containing the descriptive options list associated with the Menu Level Entry
-
prefix(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
suffix(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
Nested Schema : TranslatedString_Name
Type:
objectAdditional Properties Allowed
Show Source
A group of translated names
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
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