Get Menu Item Master Groups
post
/config/sim/v2/menuItems/getMenuItemMasterGroups
Request
Supported Media Types
- application/json
- multipart/form-data
A Request body
Root Schema : MenuItemMasterGroupGetRequestBodyv2
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
-
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3
-
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 menuItemMasterGroups for the Hierarchy
Root Schema : MenuItemMasterGroupGetResponsev2
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 Item Master Group 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:
array
Array of Menu Item Master Group objects of the organization.
Show Source
Nested Schema : MenuItemMasterGroupResponsev2
Type:
Show Source
object
-
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
2
-
name:
object name
A string that contains translations into multiple languages
-
objectNum:
integer
Menu item master group object numberExample:
1
-
sluObjNum:
integer
Associated SLU index. Valid range is between 1 and 32. By default, it is null.Example:
4
Nested Schema : name
Type:
object
A string that contains translations into multiple languages
Example:
{
"1":"Coffee",
"2":"Kaffee",
"3":"Cafe"
}
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
object
Response 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