Get Condiment Groups
post
/config/sim/v2/menuItems/getCondimentGroups
Gets all the Condiment Groups
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : CondimentGroupGetRequestBodyV2
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 Condiment Group objects of the organization
Root Schema : CondimentGroupGetResponseV2
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 Condiment Group objects.
-
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 Condiment Group objects.
Show Source
-
Array of:
object CondimentGroupResponseV2
Model for Condiment Group Object
Nested Schema : CondimentGroupResponseV2
Type:
objectModel for Condiment Group Object
Show Source
-
consumerDescription:
object TranslatedString_NameV2
A group of string objects representing the name of the family group in configured languages
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
name:
object TranslatedString_NameV2
A group of string objects representing the name of the family group in configured languages
-
objectNum:
integer
Object number of the condiment GroupExample:
1
Nested Schema : TranslatedString_NameV2
Type:
objectA group of string objects representing the name of the family group in configured languages
Example:
{
"1":"Family Group 1",
"2":"Familiengruppe 1",
"3":"Grupo familiar 1"
}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