Get Condiment Groups
post
/config/sim/v2/menuItems/getCondimentGroups
Gets all the Condiment Groups
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object
-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name
-
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed
-
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3
-
limit:
integer
If using paging, number of results returned in this page.Example:
100
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0
-
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc
-
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Condiment Groups
Nested Schema : CondimentGroupV2
Type:
object
Model for Condiment Group Object
Show Source
-
consumerDescription:
object consumerDescription
Consumer Description
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1
-
name:
object name
Name
-
objectNum:
integer
Object number of the condiment GroupExample:
1
Nested Schema : consumerDescription
Type:
object
Consumer Description
Example:
{
"1":"Family Group 1",
"2":"Familiengruppe 1",
"3":"Grupo familiar 1"
}
Nested Schema : name
Type:
object
Name
Example:
{
"1":"Family Group 1",
"2":"Familiengruppe 1",
"3":"Grupo familiar 1"
}