Get Condiment Groups
post
/config/sim/v1/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
Objects included in the response.Example:
hierUnitId
-
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 the translated strings returned.Example:
en-US, es-ES, es-MX
-
limit:
integer
If using paging, number of results returned in this page.Example:
0
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0
-
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc
-
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Condiment Groups
Root Schema : CondimentGroupGetResponseV1
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:
array
Array of Condiment Group objects.
Show Source
-
Array of:
object CondimentGroupResponseV1
Model for Condiment Group Object
Nested Schema : CondimentGroupResponseV1
Type:
object
Model for Condiment Group Object
Show Source
-
consumerDescription:
object consumerDescription
Consumer Description
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
1
-
hierUnitName:
object hierUnitName
Hier Unit Name
-
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 : hierUnitName
Type:
object
Hier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}
Nested Schema : name
Type:
object
Name
Example:
{
"1":"Family Group 1",
"2":"Familiengruppe 1",
"3":"Grupo familiar 1"
}